Skip to content
/Entity Risk Rating

BNDRY API (v1alpha)

API for the BNDRY platform

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
MIT License
Languages
Servers
Mock server
https://docs.bndry.net/_mock/apis/openapi/
BNDRY API
https://api.bndry.app/

Forms

Operations

Entities

Operations

Entity Risk Rating

Service for managing risk rating jobs for individual entities.

Operations

Retrieve a risk rating job

Request

Retrieves details about a specific risk rating job.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

individualEntityRiskRatingJobstringrequired

The individualEntityRiskRatingJob id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) Output only. The resource name of the job. Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job} correct_name_format // name must follow format 'entities/-/individualEntityRiskRatingJobs/*' string.example = ["entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891"]

createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
Response
application/json
{
  "name": "entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891",
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z"
}

List risk rating jobs

Request

Lists risk rating jobs for a specific entity.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Query
pageSizeinteger(int32)(page_size)

Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageTokenstring(page_token)

Optional. A page token, received from a previous ListIndividualEntityRiskRatingJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIndividualEntityRiskRatingJobs must match the call that provided the page token.

skipinteger(int32)(skip)>= 0

Optional. The number of jobs to skip before starting to collect the result set.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/individualEntityRiskRatingJobs?pageSize=25&pageToken=ChAIAhABGAEiAggC&skip=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
individualEntityRiskRatingJobsArray of objects(individual_entity_risk_rating_jobs)

The list of risk rating jobs.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list. string.example = ["cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA=="]

totalSizeinteger(int32)(total_size)

The total number of jobs matching the request. int32.example = [47]

Response
application/json
{
  "individualEntityRiskRatingJobs": [
    { … }
  ],
  "nextPageToken": "cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA==",
  "totalSize": 47
}

Create a risk rating job

Request

Creates a new risk rating job.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Query
individualEntityRiskRatingJobIdstring(individual_entity_risk_rating_job_id)[ 4 .. 63 ] charactersrequired

REQUIRED. The ID to use for the job, which will become the final component of the job's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Bodyapplication/json

Required. The risk rating job to create.

namestring(name)

(IDENTIFIER) Output only. The resource name of the job. Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job} correct_name_format // name must follow format 'entities/-/individualEntityRiskRatingJobs/*' string.example = ["entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891"]

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/individualEntityRiskRatingJobs?individualEntityRiskRatingJobId=pep-sanction-screen-001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891",
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) Output only. The resource name of the job. Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job} correct_name_format // name must follow format 'entities/-/individualEntityRiskRatingJobs/*' string.example = ["entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891"]

createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
Response
application/json
{
  "name": "entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891",
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z"
}

Run a risk rating job

Request

Runs a risk rating job.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

individualEntityRiskRatingJobstringrequired

The individualEntityRiskRatingJob id.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}:run' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
One of:

This resource represents a long-running operation that is the result of a network API call.

namestring(name)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject(google.protobuf.Any)
doneboolean(done)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

errorobject(google.rpc.Status)required
error.​codeinteger(int32)(code)

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

error.​messagestring(message)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

error.​detailsArray of objects(details)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Response
application/json
{
  "name": "string",
  "metadata": {
    "type": "string",
    "value": "string"
  },
  "done": true,
  "error": {
    "code": 0,
    "message": "string",
    "details": [ … ]
  }
}

GetOperation

Request

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.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

individualEntityRiskRatingJobstringrequired

The individualEntityRiskRatingJob id.

operationstringrequired

The operation id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}/operations/{operation}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
One of:

This resource represents a long-running operation that is the result of a network API call.

namestring(name)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject(google.protobuf.Any)
doneboolean(done)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

errorobject(google.rpc.Status)required
error.​codeinteger(int32)(code)

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

error.​messagestring(message)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

error.​detailsArray of objects(details)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Response
application/json
{
  "name": "string",
  "metadata": {
    "type": "string",
    "value": "string"
  },
  "done": true,
  "error": {
    "code": 0,
    "message": "string",
    "details": [ … ]
  }
}

Individual Entity Verification

Service for managing individual entity verification jobs.

Operations

Onboard Individual Entity

Service for managing individual entity onboarding jobs.

Operations

Entity PEP Sanctions Check

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

Operations