Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Compliance

Batch create account entity relationships

Associates multiple entities with an account under a single relationship type.

post/v0/accounts/{id}/entity_relationships/batch

Path parameters

idstring required

The ID of the Account object.

Example:account_xyz123

Account ID

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests

Request body

entity_idsEntityID[] required

List of entity IDs to associate with the account under the specified relationship type.

relationship_type'account_holder' | 'authorized_signer' | 'authorized_user' required

Indicates the type of Entity

Example request

{
  "entity_ids": [
    "entity_xyz123"
  ]
}

Response

Entity relationships created successfully.

account_idstring required

The ID of the Account object.

relationship_type'account_holder' | 'authorized_signer' | 'authorized_user' required

Indicates the type of Entity

entity_idsEntityID[] required

List of entity IDs associated with the account under the specified relationship type.

Example response

{
  "account_id": "account_xyz123",
  "entity_ids": [
    "entity_xyz123"
  ]
}