Delete an entity

API Reference

Entities

Delete an entity

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

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

Automations

Service for managing and executing automations.

This description was generated by a custom Redocly generator.

Operations

Documents

Service for managing documents.

Operations

Tenants

Service for managing tenants.

Operations

Form Definitions

Service for managing form definitions.

Operations

FormService

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Entities

Operations

List all entities

Request

Lists entities.

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?filter=string&pageSize=0&pageToken=string&showDeleted=true&skip=0'

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": "string",
  "totalSize": 0
}

Create an entity

Request

Creates a new entity.

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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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 \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "contactInfo": {
      "telephone": [
        "string"
      ],
      "businessTelephone": [
        "string"
      ],
      "emailAddress": [
        "user@example.com"
      ],
      "primaryContact": [
        "string"
      ],
      "website": [
        "string"
      ],
      "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": "string",
        "registrationDateTime": "1s",
        "regionCode": "string",
        "tradingName": "string",
        "registeredName": "string"
      },
      "property2": {
        "value": "string",
        "registrationDateTime": "1s",
        "regionCode": "string",
        "tradingName": "string",
        "registeredName": "string"
      }
    },
    "riskDetails": {
      "riskStatus": "RISK_STATUS_UNSPECIFIED",
      "riskStatusReason": "RISK_STATUS_REASON_UNSPECIFIED",
      "riskRating": "RISK_RATING_UNSPECIFIED"
    },
    "entityRelationships": [
      {
        "sourceEntity": "string",
        "targetEntity": "string",
        "type": "RELATIONSHIP_TYPE_UNSPECIFIED"
      }
    ],
    "createTime": "1s",
    "updateTime": "1s",
    "purgeTime": "1s",
    "annotations": {
      "property1": "string",
      "property2": "string"
    },
    "etag": "string",
    "trust": {
      "type": "TRUST_TYPE_UNSPECIFIED",
      "trust": "string",
      "settler": "string",
      "trustee": "string",
      "deed": "string"
    }
  }'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

Retrieve an entity

Request

Retrieves an entity.

Path

entitystringrequired

The entity id.

Query

namestring(name)required

Required. The resource name of the entity to retrieve. Format: entities/{entity}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}?name=string'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

Delete an entity

Request

Soft-deletes an entity.

Path

entitystringrequired

The entity id.

Query

namestring(name)required

Required. The resource name of the entity to delete. Format: entities/{entity}

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}?name=string'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

Update an entity

Request

Updates an entity.

Path

entitystringrequired

The entity id.

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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "contactInfo": {
      "telephone": [
        "string"
      ],
      "businessTelephone": [
        "string"
      ],
      "emailAddress": [
        "user@example.com"
      ],
      "primaryContact": [
        "string"
      ],
      "website": [
        "string"
      ],
      "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": "string",
        "registrationDateTime": "1s",
        "regionCode": "string",
        "tradingName": "string",
        "registeredName": "string"
      },
      "property2": {
        "value": "string",
        "registrationDateTime": "1s",
        "regionCode": "string",
        "tradingName": "string",
        "registeredName": "string"
      }
    },
    "riskDetails": {
      "riskStatus": "RISK_STATUS_UNSPECIFIED",
      "riskStatusReason": "RISK_STATUS_REASON_UNSPECIFIED",
      "riskRating": "RISK_RATING_UNSPECIFIED"
    },
    "entityRelationships": [
      {
        "sourceEntity": "string",
        "targetEntity": "string",
        "type": "RELATIONSHIP_TYPE_UNSPECIFIED"
      }
    ],
    "createTime": "1s",
    "updateTime": "1s",
    "purgeTime": "1s",
    "annotations": {
      "property1": "string",
      "property2": "string"
    },
    "etag": "string",
    "trust": {
      "type": "TRUST_TYPE_UNSPECIFIED",
      "trust": "string",
      "settler": "string",
      "trustee": "string",
      "deed": "string"
    }
  }'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

Undelete an entity

Request

Undeletes a soft-deleted entity.

Path

entitystringrequired

The entity id.

Bodyapplication/jsonrequired

namestring(name)required

Required. The resource name of the entity to undelete. Format: entities/{entity}

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:undelete' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

Add an entity relationship

Request

Path

entitystringrequired

The entity id.

Bodyapplication/jsonrequired

namestring(name)required

name must start with 'entities/':

this.startsWith('entities/')

targetEntitystring(target_entity)required

name must start with 'entities/':

this.startsWith('entities/')

relationshipTypestring(bndry.api.risk.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 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "targetEntity": "string",
    "relationshipType": "RELATIONSHIP_TYPE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

Remove an entity relationship

Request

Path

entitystringrequired

The entity id.

Bodyapplication/jsonrequired

namestring(name)required

name must start with 'entities/':

this.startsWith('entities/')

targetEntitystring(target_entity)required

name must start with 'entities/':

this.startsWith('entities/')

relationshipTypestring(bndry.api.risk.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 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "targetEntity": "string",
    "relationshipType": "RELATIONSHIP_TYPE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json

One of:

companyobject(bndry.api.risk.v1alpha.Entity.Company)required

company.typestring(bndry.api.risk.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.v1alpha.Entity.ContactInfo)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(bndry.api.risk.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": "string"
  },
  "name": "string",
  "displayName": "string",
  "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": "string"
}

View entity relationships

Request

Path

entitystringrequired

The entity id.

Query

namestring(name)required

Required. The resource name of the entity for which to view relationships. Format: entities/{entity}

viewstring(bndry.api.risk.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?name=string&view=RELATIONSHIP_VIEW_UNSPECIFIED'

Responses

Success

Bodyapplication/json

entityRelationshipsArray of objects(entity_relationships)

Response

application/json

{
  "entityRelationships": [
    { … }
  ]
}

List all countries

Request

Lists countries.

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=0&pageToken=string'

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": "string",
  "totalSize": 0
}

Automations

Documents

Tenants

Form Definitions

FormService

Workspaces

Entities

List all entities

Request

Responses

Was this helpful?

Create an entity

Request

Responses

Was this helpful?

Retrieve an entity

Request

Responses

Was this helpful?

Delete an entity

Request

Responses

Was this helpful?

Update an entity

Request

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 all countries

Request

Responses

Was this helpful?