API Reference
Log In
API Reference

POST /customers

Uma vez enviados os códigos de verificação e devidamente conferidos, sua aplicação pode agora enviar as informações da cliente afim de solicitar a criação da conta.

curl --request POST \
  --url https://whitelabel-sandbox.delbank.dev.br/v1/customers \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-delbank-partner-key: c4ca4238a0b923820dcc509a6f75849b' \
  --data '{
  "document": "012.874.010-82",
  "name": "Josevaldo Peixoto",
  "email": {
    "value": "[email protected]",
    "codeVerification": "9999"
  },
  "phone": {
    "ddd": "79",
    "number": "90000000",
    "codeVerification": "9999"
  },
  "fatherName": "string",
  "motherName": "string",
  "monthlyInvoicing": 0,
  "birthDate": "2023-06-21T19:40:08.300Z",
  "educationLevel": "UNDEFINED",
  "maritalStatus": "UNDEFINED",
  "gender": "UNINFORMED",
  "address": {
    "publicPlace": "string",
    "number": "string",
    "zipCode": "49052260",
    "neighborhood": "string",
    "complement": "string",
    "isConfirmed": true,
    "type": "COMMERCIAL",
    "cityId": 1,
    "cityName": "Aracaju"
  },
  "password": "string",
  "securityPassword": "secr",
  "tokenNotification": "string"
}'
const axios = require('axios');

const data = {
    document: '012.874.010-82',
    name: 'Josevaldo Peixoto',
    email: {
        value: '[email protected]',
        codeVerification: '9999'
    },
    phone: {
        ddd: '79',
        number: '90000000',
        codeVerification: '9999'
    },
    fatherName: 'string',
    motherName: 'string',
    monthlyInvoicing: 0,
    birthDate: '2023-06-21T19:40:08.300Z',
    educationLevel: 'UNDEFINED',
    maritalStatus: 'UNDEFINED',
    gender: 'UNINFORMED',
    address: {
        publicPlace: 'string',
        number: 'string',
        zipCode: '49052260',
        neighborhood: 'string',
        complement: 'string',
        isConfirmed: true,
        type: 'COMMERCIAL',
        cityId: 1,
        cityName: 'Aracaju'
    },
    password: 'string',
    securityPassword: 'secr'
};

const headers = {
    'Content-Type': 'application/json-patch+json',
    'x-delbank-partner-key': 'c4ca4238a0b923820dcc509a6f75849b'
};

axios.post('https://whitelabel-sandbox.delbank.dev.br/v1/customers', data, { headers })
    .then(response => {
        console.log('Response:', response.data);
    })
    .catch(error => {
        console.error('Error:', error.response.data);
    });
EnumValores Aceitos
educationLevelUndefined: Valor indefinido.
Illiterate: Representa uma pessoa analfabeta.
Elementary1To4Year: Representa o nível educacional correspondente aos anos de 1º a 4º do ensino fundamental.
Elementary5Year: Representa o nível educacional correspondente ao 5º ano do ensino fundamental.
Elementary6To4Year: Representa o nível educacional correspondente aos anos de 6º a 9º do ensino fundamental.
CompleteElementary: Representa uma pessoa que completou o ensino fundamental.
IncompleteHighSchool: Representa uma pessoa com ensino médio incompleto.
CompleteHighSchool: Representa uma pessoa que completou o ensino médio.
IncompleteHigher: Representa uma pessoa com ensino superior incompleto.
CompleteHigher: Representa uma pessoa que completou o ensino superior.
Postgraduate: Representa uma pessoa com nível de educação pós-graduado.
MastersDegree: Representa uma pessoa com um diploma de mestrado.
DoctorateDegree: Representa uma pessoa com um diploma de doutorado.
maritalStatusUndefined: Valor indefinido.
Single: Representa uma pessoa solteira.
Married: Representa uma pessoa casada.
LegallySeparated: Representa uma pessoa separada judicialmente.
Descrição: "Separado judicialmente"
Divorced: Representa uma pessoa divorciada.
StableUnion: Representa uma pessoa em união estável.
Detached: Representa uma pessoa desvinculada ou separada.
Widower: Representa uma pessoa viúva.
Others: Representa outro estado civil.
genderUninformed: Valor de informação não fornecida.
Male: Representa o gênero masculino.
Female: Representa o gênero feminino.

📘

Atenção aos campos:

password: senha de acesso/login. 6 dígitos.
securityPassword: senha de autorização de transações. 4 dígitos.

📘

Receita de utilização

Consultando o repositório: https://github.com/DelbankDev/publico-api/tree/main/receitas/criacao-conta-pf-whitelabel/customers você pode ver um exemplo prático de como utilizar o método descrito acima.