# 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
Token URL: https://auth.bndry.app/realms/bndry/protocol/openid-connect/token
Scopes:

### oauth2_authorization_code

Type: oauth2
Authorization URL: https://auth.bndry.app/realms/bndry/protocol/openid-connect/auth
Token URL: https://auth.bndry.app/realms/bndry/protocol/openid-connect/token

## Download OpenAPI description

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

## Documents

 - [GET /v1alpha/documents](https://docs.bndry.net/apis/openapi/documents/documentservice_listdocuments.md): Lists identity documents.
 - [POST /v1alpha/documents](https://docs.bndry.net/apis/openapi/documents/documentservice_createdocument.md): Creates a new identity document.
 - [GET /v1alpha/documents/{document}](https://docs.bndry.net/apis/openapi/documents/documentservice_getdocument.md): Retrieves an identity document.
 - [DELETE /v1alpha/documents/{document}](https://docs.bndry.net/apis/openapi/documents/documentservice_deletedocument.md): Soft-deletes an identity document. See AIP-164.
 - [PATCH /v1alpha/documents/{document}](https://docs.bndry.net/apis/openapi/documents/documentservice_updatedocument.md): Updates an identity document.
 - [POST /v1alpha/documents/{document}:undelete](https://docs.bndry.net/apis/openapi/documents/documentservice_undeletedocument.md): Undeletes a soft-deleted identity document. See AIP-164.
## Forms

 - [GET /v1alpha/forms](https://docs.bndry.net/apis/openapi/forms/formservice_listforms.md): List all forms.
 - [POST /v1alpha/forms](https://docs.bndry.net/apis/openapi/forms/formservice_createform.md): Creates a form.
 - [GET /v1alpha/forms/{form}](https://docs.bndry.net/apis/openapi/forms/formservice_getform.md): Retrieves a form.
 - [PATCH /v1alpha/forms/{form}](https://docs.bndry.net/apis/openapi/forms/formservice_updateform.md): Updates a form.
 - [GET /v1alpha/forms/{form}/files](https://docs.bndry.net/apis/openapi/forms/formservice_listformfiles.md): Lists form files.
 - [POST /v1alpha/forms/{form}/files](https://docs.bndry.net/apis/openapi/forms/formservice_createformfile.md): Creates form file.
 - [POST /v1alpha/forms/{form}:submit](https://docs.bndry.net/apis/openapi/forms/formservice_submitform.md): Submits a form.
## AlertService

 - [GET /v1alpha/alertTypes](https://docs.bndry.net/apis/openapi/alertservice/alertservice_listalerttypes.md): Lists alert types.
 - [GET /v1alpha/alertTypes/{alertType}](https://docs.bndry.net/apis/openapi/alertservice/alertservice_getalerttype.md): Retrieves an alert type.
 - [GET /v1alpha/alerts](https://docs.bndry.net/apis/openapi/alertservice/alertservice_listalerts.md): Lists alerts.
 - [POST /v1alpha/alerts](https://docs.bndry.net/apis/openapi/alertservice/alertservice_createalert.md)
 - [GET /v1alpha/alerts/{alert}](https://docs.bndry.net/apis/openapi/alertservice/alertservice_getalert.md): Retrieves an alert.
 - [DELETE /v1alpha/alerts/{alert}](https://docs.bndry.net/apis/openapi/alertservice/alertservice_deletealert.md): Soft-deletes an alert. The alert can be restored using `UndeleteAlert`.
 - [POST /v1alpha/alerts/{alert}:acknowledge](https://docs.bndry.net/apis/openapi/alertservice/alertservice_acknowledgealert.md): Acknowledges the given alert.
 - [POST /v1alpha/alerts/{alert}:undelete](https://docs.bndry.net/apis/openapi/alertservice/alertservice_undeletealert.md): Restores a previously soft-deleted alert.
## Tenants

 - [POST /v1alpha/tenants](https://docs.bndry.net/apis/openapi/tenants/tenantservice_createtenant.md): Creates a child tenant for the calling partner tenant.
 - [GET /v1alpha/tenants/{tenant}](https://docs.bndry.net/apis/openapi/tenants/tenantservice_gettenant.md): Retrieves the calling tenant using `tenants/current` or its canonical resource name. Child tenants cannot be retrieved with this method.
 - [GET /v1alpha/tenants/{tenant}/operations/{operation}](https://docs.bndry.net/apis/openapi/tenants/tenantservice_getoperation.md): Gets the status of a tenant creation operation.
## Entities

 - [POST /v1alpha/activityLogs](https://docs.bndry.net/apis/openapi/entities/entityservice_createactivitylog.md)
 - [GET /v1alpha/activityLogs/{activityLog}](https://docs.bndry.net/apis/openapi/entities/entityservice_getactivitylog.md): Retrieves an activity.
 - [DELETE /v1alpha/activityLogs/{activityLog}](https://docs.bndry.net/apis/openapi/entities/entityservice_deleteactivitylog.md): Soft-deletes an activity log.
 - [POST /v1alpha/activityLogs/{activityLog}:undelete](https://docs.bndry.net/apis/openapi/entities/entityservice_undeleteactivitylog.md): Undeletes a soft-deleted activity log.
 - [GET /v1alpha/activityLogs:batchGet](https://docs.bndry.net/apis/openapi/entities/entityservice_batchgetactivitylogs.md): Retrieves multiple activity logs by their resource names.
 - [GET /v1alpha/entities](https://docs.bndry.net/apis/openapi/entities/entityservice_listentities.md): Lists entities.
 - [POST /v1alpha/entities](https://docs.bndry.net/apis/openapi/entities/entityservice_createentity.md): Creates a new entity.
 - [GET /v1alpha/entities/{entity}](https://docs.bndry.net/apis/openapi/entities/entityservice_getentity.md): Retrieves an entity.
 - [DELETE /v1alpha/entities/{entity}](https://docs.bndry.net/apis/openapi/entities/entityservice_deleteentity.md): Soft-deletes an entity.
 - [PATCH /v1alpha/entities/{entity}](https://docs.bndry.net/apis/openapi/entities/entityservice_updateentity.md): Updates an entity.
 - [GET /v1alpha/entities/{entity}/activityLogs](https://docs.bndry.net/apis/openapi/entities/entityservice_listactivitylogs.md): Lists activities for an entity.
 - [GET /v1alpha/entities/{entity}/documents](https://docs.bndry.net/apis/openapi/entities/entityservice_listentitydocuments.md): Lists identity documents for an entity.
 - [GET /v1alpha/entities/{entity}/files](https://docs.bndry.net/apis/openapi/entities/entityservice_listfiles.md)
 - [POST /v1alpha/entities/{entity}/files](https://docs.bndry.net/apis/openapi/entities/entityservice_createentityfile.md)
 - [GET /v1alpha/entities/{entity}:EntityRelationships](https://docs.bndry.net/apis/openapi/entities/entityservice_viewentityrelationships.md)
 - [POST /v1alpha/entities/{entity}:addEntityRelationship](https://docs.bndry.net/apis/openapi/entities/entityservice_addentityrelationship.md)
 - [POST /v1alpha/entities/{entity}:addTag](https://docs.bndry.net/apis/openapi/entities/entityservice_addtag.md): Adds a tag to an entity.
 - [POST /v1alpha/entities/{entity}:evaluate](https://docs.bndry.net/apis/openapi/entities/entityservice_evaluateentity.md)
 - [GET /v1alpha/entities/{entity}:evaluationInput](https://docs.bndry.net/apis/openapi/entities/entityservice_getentityevaluationinput.md)
 - [DELETE /v1alpha/entities/{entity}:hardDelete](https://docs.bndry.net/apis/openapi/entities/entityservice_harddeleteentity.md): Hard-deletes an entity.
 - [POST /v1alpha/entities/{entity}:removeEntityRelationship](https://docs.bndry.net/apis/openapi/entities/entityservice_removeentityrelationship.md)
 - [POST /v1alpha/entities/{entity}:removeTag](https://docs.bndry.net/apis/openapi/entities/entityservice_removetag.md): Removes a tag from an entity.
 - [POST /v1alpha/entities/{entity}:undelete](https://docs.bndry.net/apis/openapi/entities/entityservice_undeleteentity.md): Undeletes a soft-deleted entity.
 - [GET /v1alpha/entities:batchGet](https://docs.bndry.net/apis/openapi/entities/entityservice_batchgetentities.md): Retrieves multiple entities by their resource names.
## ActivityService

 - [GET /v1alpha/activityLogTypes](https://docs.bndry.net/apis/openapi/activityservice/activityservice_listactivitylogtype.md)
 - [POST /v1alpha/activityLogTypes](https://docs.bndry.net/apis/openapi/activityservice/activityservice_createactivitylogtype.md)
 - [GET /v1alpha/activityLogTypes/{activityLogType}](https://docs.bndry.net/apis/openapi/activityservice/activityservice_getactivitylogtype.md)
 - [PATCH /v1alpha/activityLogTypes/{activityLogType}](https://docs.bndry.net/apis/openapi/activityservice/activityservice_updateactivitylogtype.md)
## Individual ID Document Verification

 - [GET /v1alpha/individualEntityIDVerificationJobs](https://docs.bndry.net/apis/openapi/individual-id-document-verification/individualentityidverificationjobservice_listindividualentityidverificationjobs.md): Lists ID Verification jobs for a specific entity.
 - [POST /v1alpha/individualEntityIDVerificationJobs](https://docs.bndry.net/apis/openapi/individual-id-document-verification/individualentityidverificationjobservice_createindividualentityidverificationjob.md): Creates a new ID Verification job.
 - [GET /v1alpha/individualEntityIDVerificationJobs/{individualEntityIDVerificationJob}](https://docs.bndry.net/apis/openapi/individual-id-document-verification/individualentityidverificationjobservice_getindividualentityidverificationjob.md): Retrieves details about a specific ID Verification job.
 - [GET /v1alpha/individualEntityIDVerificationJobs/{individualEntityIDVerificationJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/individual-id-document-verification/individualentityidverificationjobservice_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.
 - [POST /v1alpha/individualEntityIDVerificationJobs/{individualEntityIDVerificationJob}:run](https://docs.bndry.net/apis/openapi/individual-id-document-verification/individualentityidverificationjobservice_runindividualentityidverificationjob.md): Runs an ID Verification job.
## Individual Risk Rating

 - [GET /v1alpha/entities/{entity}/individualEntityRiskRatingJobs](https://docs.bndry.net/apis/openapi/individual-risk-rating/individualentityriskratingjobservice_listindividualentityriskratingjobs.md): Lists risk rating jobs for a specific entity.
 - [POST /v1alpha/entities/{entity}/individualEntityRiskRatingJobs](https://docs.bndry.net/apis/openapi/individual-risk-rating/individualentityriskratingjobservice_createindividualentityriskratingjob.md): Creates a new risk rating job.
 - [GET /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}](https://docs.bndry.net/apis/openapi/individual-risk-rating/individualentityriskratingjobservice_getindividualentityriskratingjob.md): Retrieves details about a specific risk rating job.
 - [GET /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/individual-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.
 - [POST /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}:run](https://docs.bndry.net/apis/openapi/individual-risk-rating/individualentityriskratingjobservice_runindividualentityriskratingjob.md): Runs a risk rating job.
## Individual Entity Verification

 - [GET /v1alpha/individualEntityVerificationJobs](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_listindividualentityverificationjobs.md): Lists individual entity verification jobs for a specific entity.
 - [POST /v1alpha/individualEntityVerificationJobs](https://docs.bndry.net/apis/openapi/individual-entity-verification/individualentityverificationjobservice_createindividualentityverificationjob.md): Creates a new 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.
 - [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.
 - [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

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

 - [GET /v1alpha/pepSanctionBusinessEntityJobs](https://docs.bndry.net/apis/openapi/business-pep-sanctions-check/pepsanctionbusinessentityjobservice_listpepsanctionbusinessentityjobs.md): Lists PEP and sanctions screening jobs for a specific entity.
 - [POST /v1alpha/pepSanctionBusinessEntityJobs](https://docs.bndry.net/apis/openapi/business-pep-sanctions-check/pepsanctionbusinessentityjobservice_createpepsanctionbusinessentityjob.md): Creates a new PEP and sanctions screening job.
 - [GET /v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}](https://docs.bndry.net/apis/openapi/business-pep-sanctions-check/pepsanctionbusinessentityjobservice_getpepsanctionbusinessentityjob.md): Retrieves details about a specific PEP and sanctions screening job.
 - [GET /v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/business-pep-sanctions-check/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.
 - [POST /v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}:run](https://docs.bndry.net/apis/openapi/business-pep-sanctions-check/pepsanctionbusinessentityjobservice_runpepsanctionbusinessentityjob.md): Runs a PEP and sanctions screening job.
## Individual PEP Sanctions Check

 - [GET /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs](https://docs.bndry.net/apis/openapi/individual-pep-sanctions-check/pepsanctionindividualentityjobservice_listpepsanctionindividualentityjobs.md): Lists PEP and sanctions screening jobs for a specific entity.
 - [POST /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs](https://docs.bndry.net/apis/openapi/individual-pep-sanctions-check/pepsanctionindividualentityjobservice_createpepsanctionindividualentityjob.md): Creates a new PEP and sanctions screening job.
 - [GET /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}](https://docs.bndry.net/apis/openapi/individual-pep-sanctions-check/pepsanctionindividualentityjobservice_getpepsanctionindividualentityjob.md): Retrieves details about a specific PEP and sanctions screening job.
 - [GET /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/individual-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.
 - [POST /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}:run](https://docs.bndry.net/apis/openapi/individual-pep-sanctions-check/pepsanctionindividualentityjobservice_runpepsanctionindividualentityjob.md): Runs a PEP and sanctions screening job.
## RiskRatingJobService

 - [GET /v1alpha/entities/{entity}/riskRatingJobs](https://docs.bndry.net/apis/openapi/riskratingjobservice/riskratingjobservice_listriskratingjobs.md): Lists risk rating jobs for a specific entity.
 - [POST /v1alpha/entities/{entity}/riskRatingJobs](https://docs.bndry.net/apis/openapi/riskratingjobservice/riskratingjobservice_createriskratingjob.md): Creates a new risk rating job.
 - [GET /v1alpha/entities/{entity}/riskRatingJobs/{riskRatingJob}](https://docs.bndry.net/apis/openapi/riskratingjobservice/riskratingjobservice_getriskratingjob.md): Retrieves details about a specific risk rating job.
 - [GET /v1alpha/entities/{entity}/riskRatingJobs/{riskRatingJob}/operations/{operation}](https://docs.bndry.net/apis/openapi/riskratingjobservice/riskratingjobservice_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.
 - [POST /v1alpha/entities/{entity}/riskRatingJobs/{riskRatingJob}:run](https://docs.bndry.net/apis/openapi/riskratingjobservice/riskratingjobservice_runriskratingjob.md): Runs a risk rating job.