Menu
Documentation
Documentation /Atualizar titular da conta
API reference Producao Sandbox mTLS + JWT

Atualizar titular da conta

Endpoint PUT /hb/accounts/account-holders

Mesmo contrato

Sandbox e producao seguem a mesma referencia funcional para integracao.

Credencial separada

Cada ambiente exige token e certificado emitidos especificamente para ele.

Leitura operacional

Consulte autenticacao, seguranca e fluxos de accounts sem trocar de referencia.

Atualizar titular da conta

Endpoint: PUT /hb/accounts/account-holders

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": []
}

PUT /hb/accounts/account-holders

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: FINTECH, OPERADOR, ADMIN, GERENTE
  • Scopes: account.create

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: UpdateAccountHolderDto

CampoTipoObrigatorioDetalhes
namestringSim-
document_numberstringSim-
person_typeTipoPessoaSimValores permitidos: 1, 2
statusSituacaoCorrentistaSimValores permitidos: 1, 2
emailstringSim-
phone_numberstringSim-
addressCustomerAddressDtoSimObjeto esperado: { zipCode: string; addressLine: string; buildingNumber: string; neighborhood: string; complement?: string; city: string; state: BrazilianState (enum: AC, AL, AP, AM, BA, CE, ...); country?: string }

Headers

  • Authorization: Bearer <jwt>: obrigatorio.
  • x-account-id: obrigatorio para informar a conta do contexto da operacao.

Exemplos de requisicao

bash
curl -X PUT "https://uzepay-mtls.deploy.pixland.com.br/hb/accounts/account-holders" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "x-account-id: SEU_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string_exemplo",
  "document_number": "12345678901",
  "person_type": "1",
  "status": "1",
  "email": "usuario@empresa.com",
  "phone_number": "5511999999999",
  "address": {
    "zipCode": "string_exemplo",
    "addressLine": "string_exemplo",
    "buildingNumber": "string_exemplo",
    "neighborhood": "string_exemplo",
    "city": "string_exemplo",
    "state": "AC"
  }
}'

Response

Data (schema)

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

Sucesso (200):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "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/accounts/account-holders",
  "details": []
}