https://docs.bndry.net/_mock/apis/openapi/
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.
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.
Optional. If true, soft-deleted entities will be included in the response. See AIP-164.
Optional. The number of entities to skip before starting to collect the result set.
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities
curl -i -X GET \
'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities?filter=string&pageSize=0&pageToken=string&showDeleted=true&skip=0'
{ "entities": [ { … } ], "nextPageToken": "string", "totalSize": 0 }
Required. The entity to create.
Required. The entity to create.
(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.
Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities
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"
}
}'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}
curl -i -X GET \
'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}?name=string'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}
curl -i -X DELETE \
'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}?name=string'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
Required. The entity to update.
The entity's name
field is used to identify the entity to update. Format: entities/{entity}
Required. The entity to update.
The entity's name
field is used to identify the entity to update. Format: entities/{entity}
(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.
Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}
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"
}
}'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:undelete
curl -i -X POST \
'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:undelete' \
-H 'Content-Type: application/json' \
-d '{
"name": "string"
}'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:addEntityRelationship
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"
}'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:removeEntityRelationship
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"
}'
Success
(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.
Output only. The timestamp when the entity was created.
Output only. The timestamp when the entity was most recently updated.
Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.
{ "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" }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:EntityRelationships
curl -i -X GET \
'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:EntityRelationships?name=string&view=RELATIONSHIP_VIEW_UNSPECIFIED'
{ "entityRelationships": [ { … } ] }
https://docs.bndry.net/_mock/apis/openapi/v1alpha/countries
curl -i -X GET \
'https://docs.bndry.net/_mock/apis/openapi/v1alpha/countries?pageSize=0&pageToken=string'
{ "countries": [ { … } ], "nextPageToken": "string", "totalSize": 0 }