Skip to main content
POST
Criar uma Conta de Instrumento

Cabeçalhos

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

X-Idempotency
string

Uma chave única que garante a idempotência da transação. Se não fornecida, o sistema gera automaticamente um hash SHA-256 com base no corpo da requisição. As chaves são escopadas por organização e ledger.

Sempre valide o header de resposta X-Idempotency-Replayed para distinguir transações novas de replays em cache.

Consulte Retentativas e idempotência para boas práticas.

X-TTL
integer

O tempo de vida (TTL) da chave de idempotência, definido em segundos. Se não fornecido, o padrão é 300 segundos (5 minutos). Apenas o TTL da primeira requisição é utilizado; alterá-lo em retentativas não tem efeito.

Consulte Retentativas e idempotência para mais detalhes.

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

O identificador único da Organização associada ao Ledger.

holder_id
string
obrigatório

ID do titular (UUID)

Corpo

application/json
accountId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

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"

holderId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

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

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

bankingDetails
object
document
string
Maximum string length: 100
Exemplo:

"91315026015"

id
string<uuid>
Exemplo:

"00000000-0000-0000-0000-000000000000"

metadata
object
regulatoryFields
object
type
string
Maximum string length: 100
Exemplo:

"NATURAL_PERSON"

Resposta

OK

accountId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

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"

holderId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

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

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

bankingDetails
object
document
string
Maximum string length: 100
Exemplo:

"91315026015"

id
string<uuid>
Exemplo:

"00000000-0000-0000-0000-000000000000"

metadata
object
regulatoryFields
object
type
string
Maximum string length: 100
Exemplo:

"NATURAL_PERSON"