Create a Holder

{ "createdAt": "2025-01-01T00:00:00Z", "deletedAt": "2025-01-01T00:00:00Z", "updatedAt": "2025-01-01T00:00:00Z", "addresses": { "additional1": { "city": "New York", "country": "US", "line1": "123 Financial Avenue", "line2": "Suite 1500", "state": "NY", "zipCode": "10001", "description": "Home" }, "additional2": { "city": "New York", "country": "US", "line1": "123 Financial Avenue", "line2": "Suite 1500", "state": "NY", "zipCode": "10001", "description": "Home" }, "primary": { "city": "New York", "country": "US", "line1": "123 Financial Avenue", "line2": "Suite 1500", "state": "NY", "zipCode": "10001", "description": "Home" } }, "contact": { "mobilePhone": "+1555555555", "otherPhone": "+1555555555", "primaryEmail": "john.doe@example.com", "secondaryEmail": "john.doe@example.com" }, "document": "12345678900", "externalId": "G4K7N8M2", "id": "00000000-0000-0000-0000-000000000000", "legalPerson": { "activity": "Electronic devices development", "foundingDate": "2025-01-01", "representative": { "document": "12345678900", "email": "john.doe@example.com", "name": "John Doe", "role": "CFO" }, "size": "Medium", "status": "Active", "tradeName": "Lerian Studio", "type": "Limited Liability" }, "metadata": {}, "name": "John Doe", "naturalPerson": { "birthDate": "1990-01-01", "civilStatus": "Single", "fatherName": "John Doe", "favoriteName": "John", "gender": "Male", "motherName": "Jane Doe", "nationality": "Brazilian", "socialName": "John Doe", "status": "Active" }, "type": "NATURAL_PERSON" }

{ "code": "ERR-0001", "detail": "Property foo is required but is missing.", "errors": [ { "location": "<string>", "message": "<string>", "value": "<unknown>" } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example", "upstream": { "code": "E4001", "message": "account not found at provider" } }

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

string

Idempotency key to safely retry the create; an identical retry returns the original holder

X-TTL

string

Idempotency slot TTL in seconds (default 300)

Path Parameters

organization_id

string

required

Organization ID (UUID)

Body

application/json

addresses

object

required

Show child attributes

contact

object

required

Show child attributes

document

string

required

Maximum string length: 100

Example:

"12345678900"

externalId

string | null

required

Maximum string length: 256

Example:

"G4K7N8M2"

legalPerson

object

required

Show child attributes

metadata

object

required

Show child attributes

name

string

required

Maximum string length: 256

Example:

"John Doe"

naturalPerson

object

required

Show child attributes

type

string | null

required

Maximum string length: 100

Example:

"NATURAL_PERSON"

Response

Created

createdAt

string<date-time>

required

Example:

"2025-01-01T00:00:00Z"

deletedAt

string<date-time> | null

required

Example:

"2025-01-01T00:00:00Z"

updatedAt

string<date-time>

required

Example:

"2025-01-01T00:00:00Z"

addresses

object

Show child attributes

contact

object

Show child attributes

document

string

Maximum string length: 100

Example:

"12345678900"

externalId

string

Maximum string length: 256

Example:

"G4K7N8M2"

string<uuid>

Example:

"00000000-0000-0000-0000-000000000000"

legalPerson

object

Show child attributes

metadata

object

Show child attributes

name

string

Maximum string length: 256

Example:

"John Doe"

naturalPerson

object

Show child attributes

type

string

Maximum string length: 100

Example:

"NATURAL_PERSON"

Getting started

Current (v2)

Compatibility (v1)

Error handling

Create a Holder

Authorizations

Headers

Path Parameters

Body

Response