Skip to content
API Reference/
/
Evaluate entity against t...

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

Add an entity relationship

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Bodyapplication/jsonrequired
targetEntitystring(target_entity)required

correct_name_format // name must start with 'entities/'

relationshipTypestring(bndry.api.risk.entities.v1alpha.RelationshipType)required
Enum"RELATIONSHIP_TYPE_UNSPECIFIED""DIRECTOR_OF""INVERSE_DIRECTOR_OF""SHAREHOLDER_OF""INVERSE_SHAREHOLDER_OF""BENEFICIAL_OWNER_OF""INVERSE_BENEFICIAL_OWNER_OF""OWNER_OF""INVERSE_OWNER_OF""UBO_OF"
curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:addEntityRelationship' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "targetEntity": "entities/example-financial-services",
    "relationshipType": "RELATIONSHIP_TYPE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json
One of:
namestring(name)

(IDENTIFIER) The resource name of the entity. Format: entities/{entity}

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the entity, to be used in user interfaces. Must be <= 63 characters.

contactInfoobject(bndry.api.risk.entities.v1alpha.Entity.ContactInfo)
registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)
entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

externalIdsobject(bndry.api.risk.entities.v1alpha.Entity.ExternalIds)
createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
purgeTimestring(date-time)(google.protobuf.Timestamp)read-only
annotationsobject(annotations)

(OPTIONAL) Optional. Annotations for arbitrary metadata. See AIP-148.

etagstring(etag)

Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

companyobject(bndry.api.risk.entities.v1alpha.Entity.Company)required
company.​typestring(bndry.api.risk.entities.v1alpha.Entity.Company.CompanyType)required
Enum"COMPANY_TYPE_UNSPECIFIED""PUBLIC_COMPANY""PRIVATE_COMPANY""NON_PROFIT""GOVERNMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
Response
application/json
{
  "name": "string",
  "displayName": "Example Financial Services Ltd",
  "contactInfo": {
    "telephone": [ … ],
    "businessTelephone": [ … ],
    "emailAddress": [ … ],
    "primaryContact": [ … ],
    "website": [ … ],
    "registeredBusinessAddresses": [ … ],
    "principalBusinessAddresses": [ … ],
    "residentialAddresses": [ … ]
  },
  "registration": {
    "property1": { … },
    "property2": { … }
  },
  "riskDetails": {
    "riskStatus": "RISK_STATUS_UNSPECIFIED",
    "riskStatusReason": "RISK_STATUS_REASON_UNSPECIFIED",
    "riskRating": "RISK_RATING_UNSPECIFIED"
  },
  "entityRelationships": [
    { … }
  ],
  "externalIds": {
    "cherryhub": "string",
    "custom": { … }
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "purgeTime": "2023-01-15T01:30:15.01Z",
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "abc123",
  "company": {
    "type": "COMPANY_TYPE_UNSPECIFIED",
    "industry": "Financial Services"
  }
}

Evaluate entity against the Entity Risk Rating rules

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

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

Responses

Success

Bodyapplication/json
activityLogobject(bndry.api.risk.entities.v1alpha.ActivityLog)
Response
application/json
{
  "activityLog": {
    "name": "activityLogs/01234567-89ab-cdef-0123-456789abcdef",
    "type": "ACTIVITY_TYPE_UNSPECIFIED",
    "source": "ACTIVITY_SOURCE_UNSPECIFIED",
    "payload": { … },
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z",
    "entityNames": [ … ],
    "workspace": "workspaces/01234567-89ab-cdef-0123-456789abcdef"
  }
}

Get the entity input run against risk rating rules

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

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

Responses

Success

Bodyapplication/json
inputobject(bndry.api.risk.entities.v1alpha.EntityEvaluationInput)
Response
application/json
{
  "input": {
    "entity": { … },
    "activityLogs": [ … ]
  }
}

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