Skip to content

Download OpenAPI description
Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

https://api.bndry.app/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

Forms

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Automations

Service for managing and executing automations.

Operations

Truuth

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations

EventService

EventService provides operations for managing events

Operations

Notes

Operations

Tenants

Service for managing tenants.

Operations

Entities

Operations

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. See AIP-160 for more details.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities?pageSize=25&pageToken=ChAIAhABGAE&showDeleted=true&skip=50&filter=risk_details.risk_status+%3D+%27ACTIVE%27+AND+display_name%3A%22Example%22' \
  -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 }

Create an entity

Request

Creates a new entity.

Security
oauth2_client_credentials or oauth2_authorization_code
Query
entityIdstring(entity_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.

One of:

Required. The entity to create.

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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities?entityId=john-smith-001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "Example Financial Services Ltd",
    "contactInfo": {
      "telephone": [
        "+61 2 9876 5432"
      ],
      "businessTelephone": [
        "+61 2 9876 5400"
      ],
      "emailAddress": [
        "john.smith@example.com"
      ],
      "primaryContact": [
        "Sarah Johnson"
      ],
      "website": [
        "https://www.example.com"
      ],
      "registeredBusinessAddresses": [
        {
          "revision": 0,
          "regionCode": "string",
          "languageCode": "string",
          "postalCode": "string",
          "sortingCode": "string",
          "administrativeArea": "string",
          "locality": "string",
          "sublocality": "string",
          "addressLines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        }
      ],
      "principalBusinessAddresses": [
        {
          "revision": 0,
          "regionCode": "string",
          "languageCode": "string",
          "postalCode": "string",
          "sortingCode": "string",
          "administrativeArea": "string",
          "locality": "string",
          "sublocality": "string",
          "addressLines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        }
      ],
      "residentialAddresses": [
        {
          "revision": 0,
          "regionCode": "string",
          "languageCode": "string",
          "postalCode": "string",
          "sortingCode": "string",
          "administrativeArea": "string",
          "locality": "string",
          "sublocality": "string",
          "addressLines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        }
      ]
    },
    "registration": {
      "property1": {
        "value": "12 345 678 901",
        "registrationDateTime": "1s",
        "regionCode": "NSW",
        "tradingName": "Example Financial Services",
        "registeredName": "Example Financial Services Pty Ltd"
      },
      "property2": {
        "value": "12 345 678 901",
        "registrationDateTime": "1s",
        "regionCode": "NSW",
        "tradingName": "Example Financial Services",
        "registeredName": "Example Financial Services Pty Ltd"
      }
    },
    "riskDetails": {
      "riskStatus": "RISK_STATUS_UNSPECIFIED",
      "riskStatusReason": "RISK_STATUS_REASON_UNSPECIFIED",
      "riskRating": "RISK_RATING_UNSPECIFIED"
    },
    "entityRelationships": [
      {
        "sourceEntity": "entities/john-smith",
        "targetEntity": "entities/example-financial-services",
        "type": "RELATIONSHIP_TYPE_UNSPECIFIED"
      }
    ],
    "createTime": "1s",
    "updateTime": "1s",
    "purgeTime": "1s",
    "annotations": {
      "property1": "string",
      "property2": "string"
    },
    "etag": "abc123",
    "trust": {
      "type": "TRUST_TYPE_UNSPECIFIED",
      "trust": "Smith Family Trust",
      "settler": "John Robert Smith",
      "trustee": "Example Trust Services Pty Ltd",
      "deed": "Smith Family Trust Deed 2024"
    }
  }'

Responses

Success

Bodyapplication/json
One of:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

Retrieve an entity

Request

Retrieves an entity.

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}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
One of:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

Delete an entity

Request

Soft-deletes an entity.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

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

Responses

Success

Bodyapplication/json
One of:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

Update an entity

Request

Updates an entity.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Query
updateMask.pathsArray of strings(paths)

The set of field mask paths.

Bodyapplication/json

Required. The entity to update.

The entity's name field is used to identify the entity to update. Format: entities/{entity}

One of:

Required. The entity to update.

The entity's name field is used to identify the entity to update. Format: entities/{entity}

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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}?updateMask.paths=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "Example Financial Services Ltd",
    "contactInfo": {
      "telephone": [
        "+61 2 9876 5432"
      ],
      "businessTelephone": [
        "+61 2 9876 5400"
      ],
      "emailAddress": [
        "john.smith@example.com"
      ],
      "primaryContact": [
        "Sarah Johnson"
      ],
      "website": [
        "https://www.example.com"
      ],
      "registeredBusinessAddresses": [
        {
          "revision": 0,
          "regionCode": "string",
          "languageCode": "string",
          "postalCode": "string",
          "sortingCode": "string",
          "administrativeArea": "string",
          "locality": "string",
          "sublocality": "string",
          "addressLines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        }
      ],
      "principalBusinessAddresses": [
        {
          "revision": 0,
          "regionCode": "string",
          "languageCode": "string",
          "postalCode": "string",
          "sortingCode": "string",
          "administrativeArea": "string",
          "locality": "string",
          "sublocality": "string",
          "addressLines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        }
      ],
      "residentialAddresses": [
        {
          "revision": 0,
          "regionCode": "string",
          "languageCode": "string",
          "postalCode": "string",
          "sortingCode": "string",
          "administrativeArea": "string",
          "locality": "string",
          "sublocality": "string",
          "addressLines": [
            "string"
          ],
          "recipients": [
            "string"
          ],
          "organization": "string"
        }
      ]
    },
    "registration": {
      "property1": {
        "value": "12 345 678 901",
        "registrationDateTime": "1s",
        "regionCode": "NSW",
        "tradingName": "Example Financial Services",
        "registeredName": "Example Financial Services Pty Ltd"
      },
      "property2": {
        "value": "12 345 678 901",
        "registrationDateTime": "1s",
        "regionCode": "NSW",
        "tradingName": "Example Financial Services",
        "registeredName": "Example Financial Services Pty Ltd"
      }
    },
    "riskDetails": {
      "riskStatus": "RISK_STATUS_UNSPECIFIED",
      "riskStatusReason": "RISK_STATUS_REASON_UNSPECIFIED",
      "riskRating": "RISK_RATING_UNSPECIFIED"
    },
    "entityRelationships": [
      {
        "sourceEntity": "entities/john-smith",
        "targetEntity": "entities/example-financial-services",
        "type": "RELATIONSHIP_TYPE_UNSPECIFIED"
      }
    ],
    "createTime": "1s",
    "updateTime": "1s",
    "purgeTime": "1s",
    "annotations": {
      "property1": "string",
      "property2": "string"
    },
    "etag": "abc123",
    "trust": {
      "type": "TRUST_TYPE_UNSPECIFIED",
      "trust": "Smith Family Trust",
      "settler": "John Robert Smith",
      "trustee": "Example Trust Services Pty Ltd",
      "deed": "Smith Family Trust Deed 2024"
    }
  }'

Responses

Success

Bodyapplication/json
One of:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

Undelete an entity

Request

Undeletes a soft-deleted entity.

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}:undelete' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
One of:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

Add an entity relationship

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Bodyapplication/jsonrequired
targetEntitystring(target_entity)required

name must start with 'entities/':

this.startsWith('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:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

Remove an entity relationship

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Bodyapplication/jsonrequired
targetEntitystring(target_entity)required

name must start with 'entities/':

this.startsWith('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}:removeEntityRelationship' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "targetEntity": "entities/john-smith-001",
    "relationshipType": "RELATIONSHIP_TYPE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json
One of:
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""GOVERMENTAL_ORG""ASSOCIATION_INCORPORATION"
company.​industrystring(industry)required
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)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.entities.v1alpha.Entity.RiskDetails)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity was most recently updated.

purgeTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

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.

Response
application/json
{ "company": { "type": "COMPANY_TYPE_UNSPECIFIED", "industry": "Financial Services" }, "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": [ {} ], "createTime": "1s", "updateTime": "1s", "purgeTime": "1s", "annotations": { "property1": "string", "property2": "string" }, "etag": "abc123" }

View entity relationships

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Query
viewstring(bndry.api.risk.entities.v1alpha.RelationshipView)

(OPTIONAL)

Enum"RELATIONSHIP_VIEW_UNSPECIFIED""RELATIONSHIP_VIEW_BASIC""RELATIONSHIP_VIEW_TARGET_PARTIAL""RELATIONSHIP_VIEW_FULL"
curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:EntityRelationships?view=RELATIONSHIP_VIEW_UNSPECIFIED' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
entityRelationshipsArray of objects(entity_relationships)
Response
application/json
{ "entityRelationships": [ {} ] }

List all countries

Request

Lists countries.

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

Optional. The maximum number of countries to return. The service may return fewer than this value. If unspecified, at most 50 countries 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 ListCountries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCountries must match the call that provided the page token.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/countries?pageSize=50&pageToken=ChAIAhABGAE' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
countriesArray of objects(countries)

The list of countries.

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 countries matching the request.

Response
application/json
{ "countries": [ {} ], "nextPageToken": "ChAIAhABGAE", "totalSize": 249 }

Onboard Individual (Verify Identity)

Service for managing individual entity onboarding jobs.

Operations