Skip to content
/Entities

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

ActivityService

Operations

Entities

Operations

Create an activity log

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Query
activityLogIdstring(activity_log_id)[ 4 .. 63 ] characters

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

Bodyapplication/json

Required. The entity to create.

namestring(name)

(IDENTIFIER) The resource name of the activity. Format: activityLog/{activity_log}

typestring(bndry.api.risk.entities.v1alpha.ActivityType)required
Enum"ACTIVITY_TYPE_UNSPECIFIED""PEP_AND_SANCTIONS""DOCUMENT_VERIFICATION""IDENTITY_CHECK""RISK_RATING""UNUSUAL_ACTIVITY_REPORT""SUSPICIOUS_MATTER_REPORT""CUSTOM""KYB_PROFILE""FORM_CREATED"
sourcestring(bndry.api.risk.entities.v1alpha.ActivitySource)required
Enum"ACTIVITY_SOURCE_UNSPECIFIED""BNDRY""RAPID_ID""TRUUTH""CONNECT_ID""HAWK_AI""KYC6""CUSTOMER""SIMPLE_KYC"
payloadpayload (object)(bndry.api.risk.entities.v1alpha.ActivityLogPayload)required
One of:

Required. The payload containing activity-specific data.

payload.​bndryRiskRatingResultobject(bndry.api.risk.rating.v1alpha.ActivityLog)required
entityNamesArray of strings(entity_names)required

The entities involved in this activity.

workspacestring(workspace)

(OPTIONAL) The workspace involved in this activity.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/activityLogs?activityLogId=activity-log-001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "activityLogs/01234567-89ab-cdef-0123-456789abcdef",
    "type": "ACTIVITY_TYPE_UNSPECIFIED",
    "source": "ACTIVITY_SOURCE_UNSPECIFIED",
    "payload": {
      "bndryRiskRatingResult": {
        "riskRating": {
          "label": "string",
          "value": 0
        }
      }
    },
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z",
    "entityNames": [
      "entities/john-smith-001"
    ],
    "workspace": "workspaces/01234567-89ab-cdef-0123-456789abcdef"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the activity. Format: activityLog/{activity_log}

typestring(bndry.api.risk.entities.v1alpha.ActivityType)required
Enum"ACTIVITY_TYPE_UNSPECIFIED""PEP_AND_SANCTIONS""DOCUMENT_VERIFICATION""IDENTITY_CHECK""RISK_RATING""UNUSUAL_ACTIVITY_REPORT""SUSPICIOUS_MATTER_REPORT""CUSTOM""KYB_PROFILE""FORM_CREATED"
sourcestring(bndry.api.risk.entities.v1alpha.ActivitySource)required
Enum"ACTIVITY_SOURCE_UNSPECIFIED""BNDRY""RAPID_ID""TRUUTH""CONNECT_ID""HAWK_AI""KYC6""CUSTOMER""SIMPLE_KYC"
payloadpayload (object)(bndry.api.risk.entities.v1alpha.ActivityLogPayload)required
One of:

Required. The payload containing activity-specific data.

payload.​bndryRiskRatingResultobject(bndry.api.risk.rating.v1alpha.ActivityLog)required
payload.​bndryRiskRatingResult.​rulesArray of objects(rules)read-only
payload.​bndryRiskRatingResult.​riskRatingTotalinteger(int32)(risk_rating_total)read-only

aggregate result of all rule

payload.​bndryRiskRatingResult.​riskRatingobject(bndry.api.risk.rating.v1alpha.Marker)read-only
createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
entityNamesArray of strings(entity_names)required

The entities involved in this activity.

workspacestring(workspace)

(OPTIONAL) The workspace involved in this activity.

Response
application/json
{
  "name": "activityLogs/01234567-89ab-cdef-0123-456789abcdef",
  "type": "ACTIVITY_TYPE_UNSPECIFIED",
  "source": "ACTIVITY_SOURCE_UNSPECIFIED",
  "payload": {
    "bndryRiskRatingResult": { … }
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "entityNames": [
    "entities/john-smith-001"
  ],
  "workspace": "workspaces/01234567-89ab-cdef-0123-456789abcdef"
}

Retrieve an activity log

Request

Retrieves an activity.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
activityLogstringrequired

The activityLog id.

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

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the activity. Format: activityLog/{activity_log}

typestring(bndry.api.risk.entities.v1alpha.ActivityType)required
Enum"ACTIVITY_TYPE_UNSPECIFIED""PEP_AND_SANCTIONS""DOCUMENT_VERIFICATION""IDENTITY_CHECK""RISK_RATING""UNUSUAL_ACTIVITY_REPORT""SUSPICIOUS_MATTER_REPORT""CUSTOM""KYB_PROFILE""FORM_CREATED"
sourcestring(bndry.api.risk.entities.v1alpha.ActivitySource)required
Enum"ACTIVITY_SOURCE_UNSPECIFIED""BNDRY""RAPID_ID""TRUUTH""CONNECT_ID""HAWK_AI""KYC6""CUSTOMER""SIMPLE_KYC"
payloadpayload (object)(bndry.api.risk.entities.v1alpha.ActivityLogPayload)required
One of:

Required. The payload containing activity-specific data.

payload.​bndryRiskRatingResultobject(bndry.api.risk.rating.v1alpha.ActivityLog)required
payload.​bndryRiskRatingResult.​rulesArray of objects(rules)read-only
payload.​bndryRiskRatingResult.​riskRatingTotalinteger(int32)(risk_rating_total)read-only

aggregate result of all rule

payload.​bndryRiskRatingResult.​riskRatingobject(bndry.api.risk.rating.v1alpha.Marker)read-only
createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
entityNamesArray of strings(entity_names)required

The entities involved in this activity.

workspacestring(workspace)

(OPTIONAL) The workspace involved in this activity.

Response
application/json
{
  "name": "activityLogs/01234567-89ab-cdef-0123-456789abcdef",
  "type": "ACTIVITY_TYPE_UNSPECIFIED",
  "source": "ACTIVITY_SOURCE_UNSPECIFIED",
  "payload": {
    "bndryRiskRatingResult": { … }
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "entityNames": [
    "entities/john-smith-001"
  ],
  "workspace": "workspaces/01234567-89ab-cdef-0123-456789abcdef"
}

List all entities

Request

Lists entities.

Security
oauth2_client_credentials or oauth2_authorization_code
Query
pageSizeinteger(int32)(page_size)

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

pageTokenstring(page_token)

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

showDeletedboolean(show_deleted)

Optional. If true, soft-deleted entities will be included in the response. See AIP-164.

skipinteger(int32)(skip)

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

filterstring(filter)

Optional. A filter expression that filters the results listed in the response. Filter only currently supports a fuzzy search on display name. See AIP-160 for more details.

orderBystring(order_by)

(OPTIONAL)

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities?pageSize=25&pageToken=ChAIAhABGAE&showDeleted=true&skip=50&filter=John+Smith&orderBy=displayName+desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
entitiesArray of company (object) or individual (object) or partnership (object) or sole_proprietor (object) or trust (object)(entities)

The list of entities.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of entities matching the request.

Response
application/json
{
  "entities": [
    { … }
  ],
  "nextPageToken": "ChAIAhABGAE",
  "totalSize": 127
}

Entity Risk Rating

Service for managing risk rating jobs for individual entities.

Operations

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