# 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/_bundle/apis/openapi.yaml)

## Forms

### 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.

### 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 files for a form

 - [GET /v1alpha/forms/{form}/files](https://docs.bndry.net/apis/openapi/forms/formservice_listformfiles.md): Lists form files.

### Create a form file

 - [POST /v1alpha/forms/{form}/files](https://docs.bndry.net/apis/openapi/forms/formservice_createformfile.md): Creates form file.

### Submit a form

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

## Entities

### Create an activity log

 - [POST /v1alpha/activityLogs](https://docs.bndry.net/apis/openapi/entities/entityservice_createactivitylog.md)

### Retrieve an activity log

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

### Delete an activity log

 - [DELETE /v1alpha/activityLogs/{activityLog}](https://docs.bndry.net/apis/openapi/entities/entityservice_deleteactivitylog.md): Soft-deletes an activity log.

### Undelete an activity log

 - [POST /v1alpha/activityLogs/{activityLog}:undelete](https://docs.bndry.net/apis/openapi/entities/entityservice_undeleteactivitylog.md): Undeletes a soft-deleted activity log.

### 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.

### List activity logs for an entity

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

### List files for an entity

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

### Create a file for an entity

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

### View entity relationships

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

### Add an entity relationship

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

### Add a tag to an entity

 - [POST /v1alpha/entities/{entity}:addTag](https://docs.bndry.net/apis/openapi/entities/entityservice_addtag.md): Adds a tag to an entity.

### Evaluate entity against the Entity Risk Rating rules

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

### Get the entity input run against risk rating rules

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

### Hard Delete an entity

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

### Remove an entity relationship

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

### Remove a tag from an entity

 - [POST /v1alpha/entities/{entity}:removeTag](https://docs.bndry.net/apis/openapi/entities/entityservice_removetag.md): Removes a tag from 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.

## ActivityService

### List all activity log types

 - [GET /v1alpha/activityLogTypes](https://docs.bndry.net/apis/openapi/activityservice/activityservice_listactivitylogtype.md)

### Create an activity log type

 - [POST /v1alpha/activityLogTypes](https://docs.bndry.net/apis/openapi/activityservice/activityservice_createactivitylogtype.md)

### Retrieve an activity log type

 - [GET /v1alpha/activityLogTypes/{activityLogType}](https://docs.bndry.net/apis/openapi/activityservice/activityservice_getactivitylogtype.md)

### Update an activity log type

 - [PATCH /v1alpha/activityLogTypes/{activityLogType}](https://docs.bndry.net/apis/openapi/activityservice/activityservice_updateactivitylogtype.md)

## Entity Risk Rating

Service for managing risk rating jobs for individual entities.

### 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.

### 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.

### 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.

### 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.

## Individual Entity Verification

Service for managing individual entity verification jobs.

### List individual entity verification jobs

 - [GET /v1alpha/individualEntityVerificationJobs](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_listindividualentityverificationjobs.md): Lists individual entity verification jobs for a specific entity.

### Create an individual entity verification job

 - [POST /v1alpha/individualEntityVerificationJobs](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_createindividualentityverificationjob.md): Creates a new individual entity verification job.

### Retrieve an individual entity verification job

 - [GET /v1alpha/individualEntityVerificationJobs/{individualEntityVerificationJob}](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_getindividualentityverificationjob.md): Retrieves details about a specific individual entity verification job.

### GetOperation

 - [GET /v1alpha/individualEntityVerificationJobs/{individualEntityVerificationJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_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.

### Run an individual entity verification job

 - [POST /v1alpha/individualEntityVerificationJobs/{individualEntityVerificationJob}:run](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_runindividualentityverificationjob.md): Runs an individual entity verification job.

## Onboard Individual Entity

Service for managing individual entity onboarding jobs.

### List onboard individual entity jobs

 - [GET /v1alpha/entities/{entity}/onboardIndividualEntityJobs](https://docs.bndry.net/apis/openapi/onboard-individual-entity/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-entity/onboardindividualentityjobservice_createonboardindividualentityjob.md): Creates a new onboard individual entity job.

### Retrieve an onboard individual entity job

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

### GetOperation

 - [GET /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/onboard-individual-entity/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.

### Run an onboard individual entity job

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

## PepSanctionBusinessEntityJobService

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

### List PEP and sanctions screening jobs for business entities

 - [GET /v1alpha/pepSanctionBusinessEntityJobs](https://docs.bndry.net/apis/openapi/pepsanctionbusinessentityjobservice/pepsanctionbusinessentityjobservice_listpepsanctionbusinessentityjobs.md): Lists PEP and sanctions screening jobs for a specific entity.

### Create a PEP and sanctions screening job for business entities

 - [POST /v1alpha/pepSanctionBusinessEntityJobs](https://docs.bndry.net/apis/openapi/pepsanctionbusinessentityjobservice/pepsanctionbusinessentityjobservice_createpepsanctionbusinessentityjob.md): Creates a new PEP and sanctions screening job.

### Retrieve a PEP and sanctions screening job for a business entity

 - [GET /v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}](https://docs.bndry.net/apis/openapi/pepsanctionbusinessentityjobservice/pepsanctionbusinessentityjobservice_getpepsanctionbusinessentityjob.md): Retrieves details about a specific PEP and sanctions screening job.

### GetOperation

 - [GET /v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/pepsanctionbusinessentityjobservice/pepsanctionbusinessentityjobservice_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.

### Run a PEP and sanctions screening job for a business entity

 - [POST /v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}:run](https://docs.bndry.net/apis/openapi/pepsanctionbusinessentityjobservice/pepsanctionbusinessentityjobservice_runpepsanctionbusinessentityjob.md): Runs a PEP and sanctions screening job.

## Entity PEP Sanctions Check

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

### 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.

### 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.

### 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.

### 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.