Menu
Documentation
Documentation /Criar conta individual
API reference Producao Sandbox mTLS + JWT

Criar conta individual

Endpoint POST /hb/accounts/individual

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.

Criar conta individual

Endpoint: POST /hb/accounts/individual

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/accounts/individual

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Nao exige conta ativa
  • Roles: FINTECH, OPERADOR, ADMIN
  • Scopes: account.create

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: CreateIndividualAccountDto

CampoTipoObrigatorioDetalhes
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 }. Para Brasil, use BR.
phonePhoneDtoSimObjeto esperado: { countryCode: string; number: string }. Para Brasil, use countryCode como 55 e number com DDD.
occupationstringSimCodigo de ocupacao do cliente. Exemplo: OCP0001.
pepPEPSimValores permitidos: NONE, SELF, RELATED
genderGeneroSimValores aceitos na nossa API: M, F, MASPULINO, FEMININO.
nationalitystringSim-
relationshipStatusEstadoCivilSimValores permitidos: SOLTEIRO, CASADO
educationEscolaridadeSimValores permitidos: NAO_ALFABETIZADO, ENSINO_FUNDAMENTAL_INCOMPLETO, ENSINO_FUNDAMENTAL_COMPLETO, ENSINO_MEDIO_INCOMPLETO, ENSINO_MEDIO_COMPLETO, ENSINO_SUPERIOR_INCOMPLETO, ENSINO_SUPERIOR_COMPLETO, POS_GRADUACAO
agencystringSimCodigo da agencia. Use 0001.
registerNamestringSimNome conforme consta no documento de identificacao, sem abreviacoes.
socialNamestringSimNome pelo qual a pessoa gostaria de ser chamada.
documentNumberPhotostringSimNumero do documento que sera enviado para analise, como RG ou CNH.
dateNumberDocumentPhotostringSimData de emissao do documento com foto no formato yyyy-MM-dd.
documentNumberstringSimCPF do cliente.
emailstringSim-
documentTypedocumentTypeEnSimValores permitidos: RG, CNH
issuerEntitystringNaoOrgao emissor do documento enviado para analise.
birthDatestringSimData de nascimento no formato yyyy-MM-dd. O cliente deve ter no minimo 18 anos.
motherNamestringSimNome da mae como consta no documento de identidade.
fintechIdstringNao-
assertedIncomenumberSimValor em reais da renda declarada pelo cliente.

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://uzepay-mtls.deploy.pixland.com.br/hb/accounts/individual" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "address": {
    "zipCode": "01310930",
    "addressLine": "Avenida Paulista",
    "buildingNumber": "1000",
    "complement": "Conjunto 1204",
    "neighborhood": "Bela Vista",
    "city": "Sao Paulo",
    "state": "SP",
    "country": "BR"
  },
  "phone": {
    "countryCode": "55",
    "number": "11987654321"
  },
  "occupation": "OCP0001",
  "pep": "NONE",
  "gender": "M",
  "nationality": "BRASILEIRA",
  "relationshipStatus": "CASADO",
  "education": "ENSINO_SUPERIOR_COMPLETO",
  "agency": "0001",
  "registerName": "Mariana Costa Almeida",
  "socialName": "Mariana Costa Almeida",
  "documentNumberPhoto": "457891236",
  "dateNumberDocumentPhoto": "2018-06-20",
  "documentNumber": "39053344705",
  "email": "mariana.almeida@example.com",
  "documentType": "RG",
  "issuerEntity": "SSP",
  "birthDate": "1992-08-24",
  "motherName": "Helena Costa Almeida",
  "assertedIncome": 7200
}'

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/accounts/individual",
  "details": []
}