Menu
Documentation

Vincular conta ao acesso

Endpoint: POST /hb/multi-access/accounts/:id/link-account

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/:id/link-account

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

Request

Path params

CampoTipo
idstring

Query params

Nao possui.

Body

DTO: LinkAccountToAccessDto

CampoTipoObrigatorioDetalhes
accountIdstringSim-
fintechIdstringSim-
relationTypeenumNaoValores permitidos: MAIN, PAYMENT, VIEWER, OPERATOR

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/hb/multi-access/accounts/123/link-account" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "123",
  "fintechId": "123"
}'

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/:id/link-account",
  "details": []
}