Skip to main content
POST
Create an entity

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Idempotency key

Maximum string length: 255

Body

application/json
type
string
default:individual
required

Type of entity = individual.

Pattern: ^individual$
individual_details
object
required

Details for the individual entity

client_customer_id
string

Client customer ID for the entity object. Limit of 64 characters.

Maximum string length: 64
intended_roles
enum<string>[]

The entity's intended role. Lead highly recommends using this field to confirm data requirements for different roles to minimize errors later. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. Lead currently supports:

  • authorized_user: Individual entity with restricted access to the account, without legal responsibility. Only applies to individual entity.
  • authorized_signer: Individual entity allowed to sign on behalf of the account holder, without legal responsibility. Only applies to individual entity.
  • account_holder: Entity with full control and legal responsibility for the account. Applies to all entity types.
Available options:
authorized_user,
authorized_signer,
account_holder
Example:

"Possible values: authorized_user, authorized_signer, account_holder. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. For type = business, sole_prop, only account_holder should be provided"

risk_score
enum<string>

The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.

Available options:
low,
medium,
high
rfi_details
object
ofac_details
object

Details on OFAC on the entity.

kyc_details
object

Details on KYC on the entity.

credit_details
object[]
metadata
object

A set of key-value pairs that can be used to store additional information related to this object.

Response

Entity object created.

id
string
required

Unique ID for the Entity object.

created_at
string<date-time>
required

Timestamp at which the entity object is created.

updated_at
string<date-time>
required

Timestamp at which the entity object was last updated.

type
string
default:individual
required

Type of entity = individual.

Pattern: ^individual$
client_customer_id
string

Client customer ID for the entity object. Limit of 64 characters.

Maximum string length: 64
intended_roles
enum<string>[]

The entity's intended role. Lead highly recommends using this field to confirm data requirements for different roles to minimize errors later. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. Lead currently supports:

  • authorized_user: Individual entity with restricted access to the account, without legal responsibility. Only applies to individual entity.
  • authorized_signer: Individual entity allowed to sign on behalf of the account holder, without legal responsibility. Only applies to individual entity.
  • account_holder: Entity with full control and legal responsibility for the account. Applies to all entity types.
Available options:
authorized_user,
authorized_signer,
account_holder
Example:

"Possible values: authorized_user, authorized_signer, account_holder. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. For type = business, sole_prop, only account_holder should be provided"

risk_score
enum<string>

The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.

Available options:
low,
medium,
high
individual_details
object

Details for the individual entity

rfi_details
object
ofac_details
object

Details on OFAC on the entity.

kyc_details
object

Details on KYC on the entity.

credit_details
object[]
role_details
object[]
metadata
object

A set of key-value pairs that can be used to store additional information related to this object.