Create entity

post

https://api.atlar.com/financial-data/v2/entities

Create entity.

Body Params

legalName

string

required

length ≤ 255

Legal name.

alias

string

length ≤ 255

An additional name, an alias, for the entity.

string

length ≤ 256

Email address of the entity.

nationalIdentifier

object

address

object

Postal address.

parentId

string

length between 32 and 64

Parent Entity ID, if applicable. Set the parent entity ID if the entity is a subsidiary or a branch of another entity.

metadata

object | null

Metadata is a string-string key-value container that
can be used to store information known at the time of resource
creation. This can be retrieved later on, for instance when a
payment or expected transaction is reconciled with the booked
transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a
maximum length of 64 chars and values a maximum length of 512
chars.

By default, this field is optional. It is possible to make it
required in the Atlar Dashboard by visiting the Metadata keys
page. Requirement rules
can be specified per API resource. Both the Dashboard and the
API will then enforce these rules and give validation errors
when the required fields are not set.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Already existing equvivalent entity.

201The created entity.

400Bad request.