Skip to main content
POST
/
v0
/
accounts
/
{id}
/
entity_relationships
/
batch
Batch create account entity relationships
curl --request POST \
  --url https://api.sandbox.lead.bank/v0/accounts/{id}/entity_relationships/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "entity_ids": [
    "entity_8kL9jH7gF6dS5aQ4wE3rT2yU1iO",
    "entity_2mN3bV4cX5zL6kwdJ7hG8fD9sA0",
    "entity_1qW2eR3tY4uI5oP6aS7dF8gH9jK",
    "entity_9pLuO8iK7yJ6hT5gR4fE3dD2sS1",
    "entity_5zX4cV3bN2m1qW0eR9tY8uI7oP6"
  ],
  "relationship_type": "authorized_user"
}
'
{
  "account_id": "account_9h8g7f6e5d4c3b2a1z0y9x8w7v6",
  "relationship_type": "authorized_user",
  "entity_ids": [
    "entity_8kL9jH7gF6dS5aQ4wE3rT2yU1iO",
    "entity_2mN3bV4cX5zL6kwdJ7hG8fD9sA0",
    "entity_1qW2eR3tY4uI5oP6aS7dF8gH9jK",
    "entity_9pLuO8iK7yJ6hT5gR4fE3dD2sS1",
    "entity_5zX4cV3bN2m1qW0eR9tY8uI7oP6"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.lead.bank/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

Unique key to ensure idempotent requests

Maximum string length: 255

Path Parameters

​
id
string
required

Account ID The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

Body

application/json

Request body for batch creating entity relationships on an account.

​
entity_ids
string[]
required

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

Maximum array length: 20

The ID of your entity.

Pattern: ^entity_[^\s]{1,33}$
​
relationship_type
enum<string>
required

Indicates the type of Entity

Available options:
account_holder,
authorized_signer,
authorized_user

Response

Entity relationships created successfully.

​
account_id
string
required

The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

​
relationship_type
enum<string>
required

Indicates the type of Entity

Available options:
account_holder,
authorized_signer,
authorized_user
​
entity_ids
string[]
required

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

The ID of your entity.

Pattern: ^entity_[^\s]{1,33}$