# BNDRY API

API for the BNDRY platform

Version: v1alpha
License: MIT License

## Servers

BNDRY API
```
https://api.bndry.app
```

## Security

### oauth2_client_credentials

Type: oauth2

### oauth2_authorization_code

Type: oauth2

## Download OpenAPI description

[BNDRY API](https://docs.bndry.net/_spec/apis/openapi.yaml)

## Forms

### Retrieve a form

 - [GET /v1alpha/forms/{form}](https://docs.bndry.net/apis/openapi/forms/formservice_getform.md): Retrieves a form.

### Update a form

 - [PATCH /v1alpha/forms/{form}](https://docs.bndry.net/apis/openapi/forms/formservice_updateform.md): Updates a form.

### List all forms

 - [GET /v1alpha/forms](https://docs.bndry.net/apis/openapi/forms/formservice_listforms.md): List all forms.

### Create a form

 - [POST /v1alpha/forms](https://docs.bndry.net/apis/openapi/forms/formservice_createform.md): Creates a form.

### Submit a form

 - [POST /v1alpha/forms/{form}:submit](https://docs.bndry.net/apis/openapi/forms/formservice_submitform.md): Submits a form.

## Entities

### List all entities

 - [GET /v1alpha/entities](https://docs.bndry.net/apis/openapi/entities/entityservice_listentities.md): Lists entities.

### Create an entity

 - [POST /v1alpha/entities](https://docs.bndry.net/apis/openapi/entities/entityservice_createentity.md): Creates a new entity.

### Retrieve an entity

 - [GET /v1alpha/entities/{entity}](https://docs.bndry.net/apis/openapi/entities/entityservice_getentity.md): Retrieves an entity.

### Delete an entity

 - [DELETE /v1alpha/entities/{entity}](https://docs.bndry.net/apis/openapi/entities/entityservice_deleteentity.md): Soft-deletes an entity.

### Update an entity

 - [PATCH /v1alpha/entities/{entity}](https://docs.bndry.net/apis/openapi/entities/entityservice_updateentity.md): Updates an entity.

### Undelete an entity

 - [POST /v1alpha/entities/{entity}:undelete](https://docs.bndry.net/apis/openapi/entities/entityservice_undeleteentity.md): Undeletes a soft-deleted entity.

### Add an entity relationship

 - [POST /v1alpha/entities/{entity}:addEntityRelationship](https://docs.bndry.net/apis/openapi/entities/entityservice_addentityrelationship.md)

### Remove an entity relationship

 - [POST /v1alpha/entities/{entity}:removeEntityRelationship](https://docs.bndry.net/apis/openapi/entities/entityservice_removeentityrelationship.md)

### View entity relationships

 - [GET /v1alpha/entities/{entity}:EntityRelationships](https://docs.bndry.net/apis/openapi/entities/entityservice_viewentityrelationships.md)

### List activities for an entity

 - [GET /v1alpha/entities/{entity}/activityLogs](https://docs.bndry.net/apis/openapi/entities/entityservice_listactivitylogs.md): Lists activities for an entity.

### Retrieve an activity

 - [GET /v1alpha/activityLogs/{activityLog}](https://docs.bndry.net/apis/openapi/entities/entityservice_getactivitylog.md): Retrieves an activity.

## Entity Risk Rating

Service for managing risk rating jobs for individual entities.

### Retrieve a risk rating job

 - [GET /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}](https://docs.bndry.net/apis/openapi/entity-risk-rating/individualentityriskratingjobservice_getindividualentityriskratingjob.md): Retrieves details about a specific risk rating job.

### List risk rating jobs

 - [GET /v1alpha/entities/{entity}/individualEntityRiskRatingJobs](https://docs.bndry.net/apis/openapi/entity-risk-rating/individualentityriskratingjobservice_listindividualentityriskratingjobs.md): Lists risk rating jobs for a specific entity.

### Create a risk rating job

 - [POST /v1alpha/entities/{entity}/individualEntityRiskRatingJobs](https://docs.bndry.net/apis/openapi/entity-risk-rating/individualentityriskratingjobservice_createindividualentityriskratingjob.md): Creates a new risk rating job.

### Run a risk rating job

 - [POST /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}:run](https://docs.bndry.net/apis/openapi/entity-risk-rating/individualentityriskratingjobservice_runindividualentityriskratingjob.md): Runs a risk rating job.

### GetOperation

 - [GET /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/entity-risk-rating/individualentityriskratingjobservice_getoperation.md): Gets the latest state of a long-running operation.  Clients can use this
 method to poll the operation result at intervals as recommended by the API
 service.

## Onboard Individual (Verify Identity)

Service for managing individual entity onboarding jobs.

### Retrieve an onboard individual entity job

 - [GET /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}](https://docs.bndry.net/apis/openapi/onboard-individual-(verify-identity)/onboardindividualentityjobservice_getonboardindividualentityjob.md): Retrieves details about a specific onboard individual entity job.

### List onboard individual entity jobs

 - [GET /v1alpha/entities/{entity}/onboardIndividualEntityJobs](https://docs.bndry.net/apis/openapi/onboard-individual-(verify-identity)/onboardindividualentityjobservice_listonboardindividualentityjobs.md): Lists onboard individual entity jobs for a specific entity.

### Create an onboard individual entity job

 - [POST /v1alpha/entities/{entity}/onboardIndividualEntityJobs](https://docs.bndry.net/apis/openapi/onboard-individual-(verify-identity)/onboardindividualentityjobservice_createonboardindividualentityjob.md): Creates a new onboard individual entity job.

### Run an onboard individual entity job

 - [POST /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}:run](https://docs.bndry.net/apis/openapi/onboard-individual-(verify-identity)/onboardindividualentityjobservice_runonboardindividualentityjob.md): Runs an onboard individual entity job.

### GetOperation

 - [GET /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/onboard-individual-(verify-identity)/onboardindividualentityjobservice_getoperation.md): Gets the latest state of a long-running operation.  Clients can use this
 method to poll the operation result at intervals as recommended by the API
 service.

## Entity PEP Sanctions Check

Service for managing PEP and sanctions screening jobs for individual entities.

### Retrieve a PEP and sanctions screening job

 - [GET /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}](https://docs.bndry.net/apis/openapi/entity-pep-sanctions-check/pepsanctionindividualentityjobservice_getpepsanctionindividualentityjob.md): Retrieves details about a specific PEP and sanctions screening job.

### List PEP and sanctions screening jobs

 - [GET /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs](https://docs.bndry.net/apis/openapi/entity-pep-sanctions-check/pepsanctionindividualentityjobservice_listpepsanctionindividualentityjobs.md): Lists PEP and sanctions screening jobs for a specific entity.

### Create a PEP and sanctions screening job

 - [POST /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs](https://docs.bndry.net/apis/openapi/entity-pep-sanctions-check/pepsanctionindividualentityjobservice_createpepsanctionindividualentityjob.md): Creates a new PEP and sanctions screening job.

### Run a PEP and sanctions screening job

 - [POST /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}:run](https://docs.bndry.net/apis/openapi/entity-pep-sanctions-check/pepsanctionindividualentityjobservice_runpepsanctionindividualentityjob.md): Runs a PEP and sanctions screening job.

### GetOperation

 - [GET /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/entity-pep-sanctions-check/pepsanctionindividualentityjobservice_getoperation.md): Gets the latest state of a long-running operation.  Clients can use this
 method to poll the operation result at intervals as recommended by the API
 service.