Skip to main content
POST
Error

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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)

Parâmetros de caminho

organization_id
string
obrigatório

Organization ID (UUID)

Corpo

application/json
addresses
object
obrigatório
contact
object
obrigatório
document
string
obrigatório
Maximum string length: 100
Exemplo:

"12345678900"

externalId
string | null
obrigatório
Maximum string length: 256
Exemplo:

"G4K7N8M2"

metadata
object
obrigatório
name
string
obrigatório
Maximum string length: 256
Exemplo:

"John Doe"

naturalPerson
object
obrigatório
type
string | null
obrigatório
Maximum string length: 100
Exemplo:

"NATURAL_PERSON"

Resposta

Created

createdAt
string<date-time>
obrigatório
Exemplo:

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

deletedAt
string<date-time> | null
obrigatório
Exemplo:

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

updatedAt
string<date-time>
obrigatório
Exemplo:

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

addresses
object
contact
object
document
string
Maximum string length: 100
Exemplo:

"12345678900"

externalId
string
Maximum string length: 256
Exemplo:

"G4K7N8M2"

id
string<uuid>
Exemplo:

"00000000-0000-0000-0000-000000000000"

metadata
object
name
string
Maximum string length: 256
Exemplo:

"John Doe"

naturalPerson
object
type
string
Maximum string length: 100
Exemplo:

"NATURAL_PERSON"