Documentacao APISandbox e producao com o mesmo contrato
Accounts / Contas

Criar conta individual

Abre uma conta para pessoa fisica e inicia o fluxo de analise cadastral.

POST/hb/accounts/individual

Requisicao

AutenticacaomTLS + Bearer Token
AmbienteDefinido pelo certificado
ContaNao exige header de conta
IdempotenciaNao aplicavel

Campos obrigatorios

registerNamedocumentNumberbirthDatemotherNamephoneaddressoccupationpepassertedIncomeagency

Valores aceitos

documentTypeRG | CNH
pepNONE | SELF | RELATED
genderM | F
relationshipStatusSOLTEIRO | CASADO | DIVORCIADO | VIUVO
educationENSINO_FUNDAMENTAL | ENSINO_MEDIO_COMPLETO | ENSINO_SUPERIOR_COMPLETO | POS_GRADUACAO

Regras

  • Envie os documentos em chamadas separadas.
  • A selfie deve ser enviada antes dos demais documentos.
  • gender aceita M ou F.

Body exemplo

{
  "registerName": "Marina Costa Almeida",
  "socialName": "Marina Almeida",
  "documentNumber": "73467500048",
  "email": "marina.almeida@example.com",
  "documentNumberPhoto": "418529637",
  "documentType": "RG",
  "dateNumberDocumentPhoto": "2020-08-14",
  "issuerEntity": "SSP",
  "birthDate": "1992-04-18",
  "motherName": "Helena Costa Almeida",
  "phone": {
    "countryCode": "55",
    "number": "11988223344"
  },
  "address": {
    "zipCode": "04538000",
    "addressLine": "Rua das Acacias",
    "buildingNumber": "120",
    "complement": "Apto 42",
    "neighborhood": "Itaim Bibi",
    "city": "Sao Paulo",
    "state": "SP",
    "country": "BR"
  },
  "occupation": "Administrador",
  "pep": "NONE",
  "assertedIncome": 6500.5,
  "gender": "F",
  "nationality": "BRASILEIRO",
  "relationshipStatus": "SOLTEIRO",
  "education": "ENSINO_SUPERIOR_COMPLETO",
  "agency": "0001"
}

Exemplos de execucao

curl -X POST 'https://uzepay-mtls.deploy.pixland.com.br/hb/accounts/individual' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "registerName": "Marina Costa Almeida",
  "socialName": "Marina Almeida",
  "documentNumber": "73467500048",
  "email": "marina.almeida@example.com",
  "documentNumberPhoto": "418529637",
  "documentType": "RG",
  "dateNumberDocumentPhoto": "2020-08-14",
  "issuerEntity": "SSP",
  "birthDate": "1992-04-18",
  "motherName": "Helena Costa Almeida",
  "phone": {
    "countryCode": "55",
    "number": "11988223344"
  },
  "address": {
    "zipCode": "04538000",
    "addressLine": "Rua das Acacias",
    "buildingNumber": "120",
    "complement": "Apto 42",
    "neighborhood": "Itaim Bibi",
    "city": "Sao Paulo",
    "state": "SP",
    "country": "BR"
  },
  "occupation": "Administrador",
  "pep": "NONE",
  "assertedIncome": 6500.5,
  "gender": "F",
  "nationality": "BRASILEIRO",
  "relationshipStatus": "SOLTEIRO",
  "education": "ENSINO_SUPERIOR_COMPLETO",
  "agency": "0001"
}'

Resposta exemplo

200 OK
{
  "account": {
    "id": "01HZX...",
    "accountNumber": "CREATING",
    "status": "PENDING_DOCUMENTS"
  }
}