LElead
User Account

Batch create user account entity relationships

Changed on

Add Entities to a User Account under a single relationship type.

post/v2/user_accounts/{user_account_id}/entity_relationships/batch

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/user_accounts/{user_account_id}/entity_relationships/batch
  • Auth
    HTTP bearer

Path parameters

user_account_idstring required

The ID of the User Account object.

Example:user_account_xyz123

User Account ID

Headers

Idempotency-Keystring required

A unique key for this request, up to 255 characters. Retrying with the same key and body returns the original response without creating the relationships twice. See Idempotency.

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"
  ],
  "relationship_type": "account_holder"
}

Response

Entity relationships created successfully.

user_account_idstring required

The ID of the User 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 user account under the specified relationship type.

Example response

{
  "user_account_id": "user_account_xyz123",
  "relationship_type": "account_holder",
  "entity_ids": [
    "entity_xyz123"
  ]
}

Changes