1 - Autenticação Usuário
1.0 - Autenticação do customer via documento e senha
Para realizar a autenticação de customer, é necessário que o mesmo esteja aprovado na base; utilizará o documento e a senha que foi cadastrada para autenticação
O token gerado no response é utilizado nos Authorization para que seja realizadas transações Cash_in e Cash_out.
[POST] /api/v1/user/auth
[Parâmetros]
[HEADER]
| Propriedade | Valor |
|---|---|
| Authorization | Bearer {Token whitelabel} |
[PAYLOAD]
| Propriedade | Descrição | Obrigatório | Condição | Tipo |
|---|---|---|---|---|
| document | Documento CPF/CNPJ | Sim | String | |
| password | Senha do Customer | Sim | String |
[RESPONSES]
| Código | Descrição |
|---|---|
| 200 | Autenticação gerada com sucesso |
| 500 | Falha na autenticação |
| Propriedade | Descrição | Tipo |
|---|---|---|
| full_name | Nome completo | String |
| String | ||
| document | CPF/CNPJ | String |
| birth_date | Data de nascimento | String |
| token | Token de acesso | Object |
| address | Informações do endereço | Object |
| address.postal_code | CEP | String |
| address.country | País | String |
| address.state | Estado | String |
| address.neighborhood | Bairro | String |
| address.city | Cidade | String |
| address.street | Rua | String |
| address.number | Número | String |
| phone | Informações do telefone | Object |
| phone.phone_prefix | Prefixo | String |
| phone.phone_number | Número | String |
| account_id | Informações da conta | String |
| username | Informações da conta | String |
| qrcode | Informações da conta | String |
| avatar_url | Informações da conta | String |
| logo_url | Informações da conta | String |
| card | Informações da conta | Object |
| card.id | Informações da conta | String |
| card.defaut | Informações da conta | String |
| card.deleted | Informações da conta | String |
| card.token_id | Informações da conta | String |
| card.card_id | Informações da conta | String |
| card.user_id | Informações da conta | String |
| card.brand | Informações da conta | String |
| card.brand_cover | Informações da conta | String |
| card.holder_name | Informações da conta | String |
| card.expiration_month | Informações da conta | String |
| card.expiration_year | Informações da conta | String |
| card.first4_digits | Informações da conta | String |
| card.created_at | Informações da conta | String |
| card.updated_at | Informações da conta | String |
| card.last4_digits | Informações da conta | String |
| card.error_message | Informações da conta | String |
| success | Sucesso na consulta | Boolean |
| code | Código de sucesso | String |
| individual_id | ID do customer | String |
| steps | Documentação pendente | Array |
| status | Status da conta | String |
| status_label | Descrição do status | String |
| bank_account | Informações da conta bancária | Object |
| bank_account.type_b_account | Tipo de conta | String |
| bank_account.bank_code | Código do banco | String |
| bank_account.bank_name | Nome do banco | String |
| bank_account.agency | Agência | String |
| bank_account.account_number | Número da conta | String |
| bank_account.account_digit | Dígito | String |
{
"full_name": "Fulano da Silva",
"email": "fulnano@example.com",
"document": "12345678910",
"birth_date": "17/10/2002",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI.....",
"address": {
"postal_code": "12345678",
"country": "Brasil",
"state": "SP",
"neighborhood": "Jd. Hyorashi",
"city": "Presidente Prudente",
"street": "Gyuski tashyran",
"number": "190"
},
"phone": {
"phone_prefix": "99",
"phone_number": "999999999"
},
"account_id": "123456",
"username": "",
"qrcode": "",
"avatar_url": "http://cronos/storage/default_images/default-avatar.jpg",
"logo_url": "http://cronos/public/logo-acesso.png",
"card": {
"id": "0",
"defaut": 0,
"deleted": "",
"token_id": "",
"card_id": "",
"user_id": "",
"brand": "",
"brand_cover": "",
"holder_name": "",
"expiration_month": "",
"expiration_year": "",
"first4_digits": "",
"created_at": "",
"updated_at": "",
"last4_digits": "",
"error_message": ""
},
"success": true,
"code": 200,
"individual_id": "09ed27ea-f1d2-4176-bbc4-e60b40cb1e1f",
"steps": [
""
],
"status": "ativa",
"status_label": "ativo",
"bank_account": {
"type_b_account": "CC",
"bank_code": "000",
"bank_name": "Cronos",
"agency": "0001",
"account_number": "123456",
"account_digit": 0
}
}
| Propriedade | Descrição | Obrigatório | Tipo |
|---|---|---|---|
| success | Booleano que identifica o sucesso ou não da autenticação. | Sim | Boolean |
| code | Código de sucesso | Sim | String |
| message | Message que descreve o motivo da falha | Sim | String |
{
"success": false,
"message": "Unauthorized",
"code": 500
}