List activity logs for an entity

Forms
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Entities
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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. Filter only currently supports a fuzzy search on display name. See AIP-160 for more details.

orderBystring(order_by)

(OPTIONAL) string.example = ["displayName desc"]

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. string.example = ["ChAIAhABGAE"]

totalSizeinteger(int32)(total_size)

The total number of entities matching the request. int32.example = [127]

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. string.example = ["Example Financial Services Ltd"]

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)

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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": "2023-01-15T01:30:15.01Z",
        "regionCode": "NSW",
        "tradingName": "Example Financial Services",
        "registeredName": "Example Financial Services Pty Ltd"
      },
      "property2": {
        "value": "12 345 678 901",
        "registrationDateTime": "2023-01-15T01:30:15.01Z",
        "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"
      }
    ],
    "externalIds": {
      "cherryhub": "string",
      "custom": {
        "property1": "string",
        "property2": "string"
      }
    },
    "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"
    }
  }'

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

Retrieve an entity

Request

Retrieves an entity.

Security

oauth2_client_credentials or oauth2_authorization_code

Path

entitystringrequired

The entity id.

Query

systemstring(system)

Optional. External system identifier for external ID lookup. When provided, the entity ID in name is treated as an external ID.

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

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

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:

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

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. string.example = ["Example Financial Services Ltd"]

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)

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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": "2023-01-15T01:30:15.01Z",
        "regionCode": "NSW",
        "tradingName": "Example Financial Services",
        "registeredName": "Example Financial Services Pty Ltd"
      },
      "property2": {
        "value": "12 345 678 901",
        "registrationDateTime": "2023-01-15T01:30:15.01Z",
        "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"
      }
    ],
    "externalIds": {
      "cherryhub": "string",
      "custom": {
        "property1": "string",
        "property2": "string"
      }
    },
    "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"
    }
  }'

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

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:

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

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/' string.example = ["entities/example-financial-services"]

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

Remove 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/' string.example = ["entities/john-smith-001"]

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:

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. string.example = ["Example Financial Services Ltd"]

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. string.example = ["abc123"]

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

string.example = ["Financial Services"]

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"
  }
}

View entity relationships

Request

Security

oauth2_client_credentials or oauth2_authorization_code

Path

entitystringrequired

The entity id.

Query

viewstring(view)

(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 activity logs for an entity

Request

Lists activities for an entity.

Security

oauth2_client_credentials or oauth2_authorization_code

Path

entitystringrequired

The entity id.

Query

pageSizeinteger(int32)(page_size)

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

skipinteger(int32)(skip)

Optional. The number of resources to skip over before returning resources. Default is 0. See: https://google.aip.dev/158#skipping-results

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

Responses

Success

Bodyapplication/json

activityLogsArray of objects(activity_logs)

The list of activities.

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 = ["ChAIAhABGAE"]

totalSizeinteger(int32)(total_size)

The total number of entities matching the request. int32.example = [127]

Response

application/json

{
  "activityLogs": [
    { … }
  ],
  "nextPageToken": "ChAIAhABGAE",
  "totalSize": 127
}

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} string.example = ["activityLogs/01234567-89ab-cdef-0123-456789abcdef"]

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"

sourcestring(bndry.api.risk.entities.v1alpha.ActivitySource)required

Enum"ACTIVITY_SOURCE_UNSPECIFIED""BNDRY""RAPID_ID""TRUUTH""CONNECT_ID""HAWK_AI""KYC6""CUSTOMER"

payloadpayload (object)(bndry.api.risk.entities.v1alpha.ActivityLogPayload)required

One of:

Required. The payload containing activity-specific data.

payload.hawkRiskRatingResultobject(hawk.v1alpha.CheckCustomerResponse)read-onlyrequired

payload.hawkRiskRatingResult.caseIdstring(case_id)

Unique identifier for the case (UUID format)

payload.hawkRiskRatingResult.customerIdstring(customer_id)

Unique identifier for the customer

payload.hawkRiskRatingResult.flaggingResultsArray of objects(flagging_results)

payload.hawkRiskRatingResult.riskFactorsArray of objects(risk_factors)

payload.hawkRiskRatingResult.riskLevelstring(risk_level)

payload.hawkRiskRatingResult.screeningResultsArray of objects(screening_results)

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.

Response

application/json

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

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} string.example = ["activityLogs/01234567-89ab-cdef-0123-456789abcdef"]

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"

sourcestring(bndry.api.risk.entities.v1alpha.ActivitySource)required

Enum"ACTIVITY_SOURCE_UNSPECIFIED""BNDRY""RAPID_ID""TRUUTH""CONNECT_ID""HAWK_AI""KYC6""CUSTOMER"

payloadpayload (object)(bndry.api.risk.entities.v1alpha.ActivityLogPayload)required

One of:

Required. The payload containing activity-specific data.

entityNamesArray of strings(entity_names)required

The entities 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": {
      "hawkRiskRatingResult": {
        "caseId": "string",
        "customerId": "string",
        "flaggingResults": [
          {
            "flag": "string"
          }
        ],
        "riskFactors": [
          {
            "factor": "string"
          }
        ],
        "riskLevel": "string",
        "screeningResults": [
          {
            "type": "SCREENING_TYPE_UNSPECIFIED"
          }
        ]
      }
    },
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z",
    "entityNames": [
      "entities/john-smith-001"
    ]
  }'

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the activity. Format: activityLog/{activity_log} string.example = ["activityLogs/01234567-89ab-cdef-0123-456789abcdef"]

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"

sourcestring(bndry.api.risk.entities.v1alpha.ActivitySource)required

Enum"ACTIVITY_SOURCE_UNSPECIFIED""BNDRY""RAPID_ID""TRUUTH""CONNECT_ID""HAWK_AI""KYC6""CUSTOMER"

payloadpayload (object)(bndry.api.risk.entities.v1alpha.ActivityLogPayload)required

One of:

Required. The payload containing activity-specific data.

payload.hawkRiskRatingResultobject(hawk.v1alpha.CheckCustomerResponse)read-onlyrequired

payload.hawkRiskRatingResult.caseIdstring(case_id)

Unique identifier for the case (UUID format)

payload.hawkRiskRatingResult.customerIdstring(customer_id)

Unique identifier for the customer

payload.hawkRiskRatingResult.flaggingResultsArray of objects(flagging_results)

payload.hawkRiskRatingResult.riskFactorsArray of objects(risk_factors)

payload.hawkRiskRatingResult.riskLevelstring(risk_level)

payload.hawkRiskRatingResult.screeningResultsArray of objects(screening_results)

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.

Response

application/json

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

List documents for an entity

Request

Security

oauth2_client_credentials or oauth2_authorization_code

Path

entitystringrequired

The entity id.

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) string.example = ["displayName desc"]

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

Responses

Success

Bodyapplication/json

documentsArray of objects(documents)

The list of documents.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results.

totalSizeinteger(int32)(total_size)

The total number of documents.

Response

application/json

{
  "documents": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Create a document for an entity

Request

Security

oauth2_client_credentials or oauth2_authorization_code

Path

entitystringrequired

The entity id.

Bodyapplication/json

Required. The document to create.

namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document}

displayNamestring(display_name)[ 1 .. 128 ] charactersrequired

Optional. A mutable, user-settable field for providing a human-readable name for the document, to be used in user interfaces. Must be <= 63 characters. string.example = ["John Doe - Driver's License"] string.max_len = 128 string.min_len = 1

contentstring(byte)(content)[ 1 .. 10485760 ] charactersrequired

The content of the document. Maximum file size is 10Mib. bytes.max_len = 10485760 bytes.min_len = 1

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/documents' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "John Doe - Driver'\''s License",
    "content": "string",
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z"
  }'

Responses

Success

Bodyapplication/json

namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document}

displayNamestring(display_name)[ 1 .. 128 ] charactersrequired

Optional. A mutable, user-settable field for providing a human-readable name for the document, to be used in user interfaces. Must be <= 63 characters. string.example = ["John Doe - Driver's License"] string.max_len = 128 string.min_len = 1

contentstring(byte)(content)[ 1 .. 10485760 ] charactersrequired

The content of the document. Maximum file size is 10Mib. bytes.max_len = 10485760 bytes.min_len = 1

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

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

Response

application/json

{
  "name": "string",
  "displayName": "John Doe - Driver's License",
  "content": "string",
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z"
}

Entity Risk Rating
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Service for managing risk rating jobs for individual entities.

Operations

Individual Entity Verification
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Service for managing individual entity verification jobs.

Operations

Onboard Individual Entity
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Service for managing individual entity onboarding jobs.

Operations

Entity PEP Sanctions Check
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

BNDRY API (v1alpha)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

FormsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

EntitiesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

List all entities

Request

Responses

Was this helpful?

Create an entity

RequestExpand all

Responses

Was this helpful?

Retrieve an entity

Request

Responses

Was this helpful?

Delete an entity

Request

Responses

Was this helpful?

Update an entity

RequestExpand all

Responses

Was this helpful?

Undelete an entity

Request

Responses

Was this helpful?

Add an entity relationship

Request

Responses

Was this helpful?

Remove an entity relationship

Request

Responses

Was this helpful?

View entity relationships

Request

Responses

Was this helpful?

List activity logs for an entity

Request

Responses

Was this helpful?

Retrieve an activity log

Request

Responses

Was this helpful?

Create an activity log

RequestExpand all

Responses

Was this helpful?

List documents for an entity

Request

Responses

Was this helpful?

Create a document for an entity

Request

Responses

Was this helpful?

Entity Risk RatingCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Individual Entity VerificationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Onboard Individual EntityCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Entity PEP Sanctions CheckCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

BNDRY API (v1alpha)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Forms
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Entities
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Request

Request

Entity Risk Rating
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Individual Entity Verification
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Onboard Individual Entity
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Entity PEP Sanctions Check
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude