Menu
Documentation

Criar acesso de conta

Endpoint: POST /hb/multi-access/accounts

Aviso de habilitacao obrigatoria

Este fluxo de Multi Acesso depende de aprovacao interna e reuniao tecnica com o time de tecnologia. Somente apos o alinhamento devem ser enviados/configurados IDs, chaves e secrets necessarios da integracao.

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}

POST /hb/multi-access/accounts

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: Nao declarado
  • Scopes: Nao declarado

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: CreateAccountAccessDto

CampoTipoObrigatorioDetalhes
fintechIdstringSim-
smsCodestringSim-
fullNamestringSim-
documentNumberstringSim-
documentTypeenumSimValores permitidos: CPF, CNPJ
emailstringSim-
phonestringSim-
accessProfileIdstringSim-
accountIdsstring[]SimArray de valores primitivos
approvalPolicyTypeMultiAccessApprovalPolicyTypeSimValores permitidos: NONE, APPROVE_ABOVE_VALUE
approvalPoliciesApprovalPolicyInputDto[]NaoArray de objetos. Objeto esperado: { transactionType: string; minAmount: number; maxAmount?: number }

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/hb/multi-access/accounts" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "fintechId": "123",
  "smsCode": "string_exemplo",
  "fullName": "string_exemplo",
  "documentNumber": "12345678901",
  "documentType": "RG",
  "email": "usuario@empresa.com",
  "phone": "5511999999999",
  "accessProfileId": "123",
  "accountIds": [
    "123456"
  ],
  "approvalPolicyType": "NONE"
}'

Response

Data (schema)

Nao tipado no retorno do controller. Informe um tipo de retorno para documentar automaticamente.

Sucesso (201):

{
  "status_code": 201,
  "success": true,
  "message": "Created",
  "data": "<resultado da operacao>"
}

Erro (contrato padrao):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/hb/multi-access/accounts",
  "details": []
}