Sandbox

Teste a integração sem gastar créditos e sem depender de dados reais.

Coleção com todas as requisições deste guia. No Insomnia, importe o arquivo e preencha a api_key no ambiente.

O endereço é https://api-sandbox.brazid.com. Os caminhos, os parâmetros e as respostas são os mesmos da produção.
Use uma chave de sandbox: no painel, em Chaves de API, escolha o ambiente Sandbox ao criar a chave. Ela começa com brz_test_. Chave de sandbox não funciona na produção, e a de produção não funciona no sandbox (401 com o código WRONG_ENVIRONMENT).
Nenhuma consulta consome crédito. O credits_remaining mostra o saldo real da sua conta, que não muda.
Só os CPFs de teste da tabela abaixo têm dados. Qualquer outro CPF válido responde 404, e a data de nascimento precisa ser a da tabela.
Cada consulta demora cerca de 400 ms, para você ver o comportamento do seu código com uma API de verdade. Um dos CPFs demora 3 segundos, para testar timeouts.
Valem os mesmos limites de requisições por segundo do seu plano. Lotes e o webhook batch.completed também funcionam.
Toda resposta traz o cabeçalho x-brazid-env: sandbox.

cURL

1curl -X POST https://api-sandbox.brazid.com/v1/cpf \2 -H "x-api-key: $BRAZID_API_KEY" \3 -H "Content-Type: application/json" \4 -d '{"cpf":"529.982.247-25","birthdate":"1982-11-26"}'

200 OK

1{2 "success": true,3 "data": {4 "cpf": "52998224725",5 "name": "MARIA SOUZA LIMA",6 "birthdate": "26/11/1982",7 "day": 26,8 "month": 11,9 "year": 1982,10 "situation": "REGULAR",11 "social_name": null,12 "registration_date": "12/03/2004"13 },14 "credits_remaining": 1915}

CPFs de teste

CPF	Data de nascimento	O que acontece
Consultas com sucesso
529.982.247-25	1982-11-26	Titular regular, resposta rápida.
111.444.777-35	1990-05-02	Titular regular, resposta rápida.
300.000.001-16	1993-09-17	Titular regular.
300.000.003-88	1958-07-08	Nome longo com acentos e apóstrofo (D'ÁVILA).
300.000.004-69	2012-10-03	Titular menor de idade.
Situação cadastral
100.000.001-08	1988-01-15	Situação cadastral SUSPENSA.
100.000.002-80	1995-12-09	Situação cadastral PENDENTE DE REGULARIZAÇÃO.
100.000.003-61	1969-06-21	Situação cadastral CANCELADA DE OFÍCIO.
300.000.002-05	1984-02-29	Situação cadastral NULA.
Dados incompletos ou diferentes
390.533.447-05	1976-08-30	Campo opcional nulo: situation vem null.
Resposta lenta
200.000.001-08	1991-04-04	Resposta lenta, de 3 segundos.
400.000.001-24	1987-12-01	Resposta muito lenta, de 9 segundos, para estourar timeouts.
Erros
000.000.001-91	1980-01-01	CPF válido sem registro: 404.
999.999.990-50	1980-01-01	Falha simulada do provedor: 503 (no lote, o item vem com status error).

Os nomes e as datas são fictícios. Se a data enviada não for a da tabela, a resposta é 404, como na produção.

Cenários de teste

Fluxo normal
Consulte 300.000.001-16 com a data da tabela e confirme que a sua integração lê name, birthdate e situation.
Titular não encontrado (404)
Consulte 000.000.001-91, qualquer CPF válido fora da tabela ou um CPF da tabela com outra data de nascimento. O 404 é um resultado normal: seu sistema não deve tratá-lo como falha.
Provedor indisponível (503)
O CPF 999.999.990-50 sempre responde 503. Use-o para testar a nova tentativa com espera crescente e o aviso ao usuário. No lote, o item volta com status error.
Resposta lenta e timeout
O CPF 200.000.001-08 demora 3 segundos e o 400.000.001-24 demora 9. Com o timeout do seu cliente HTTP em 5 segundos, o primeiro deve passar e o segundo deve estourar.
Situação cadastral
Os CPFs 100.000.001-08, 100.000.002-80, 100.000.003-61 e 300.000.002-05 voltam com situações diferentes de REGULAR. Teste se o seu sistema bloqueia ou sinaliza esses titulares.
Campos nulos
O CPF 390.533.447-05 devolve situation null. Garanta que o seu código não quebra com null.
Acentos e menores de idade
O CPF 300.000.003-88 tem nome longo com acentos e apóstrofo, e o 300.000.004-69 é de um menor de idade. Confira a codificação UTF-8 e as suas regras de idade.
CPF malformado (400 e 422)
Não precisa da tabela: 1234567890 (10 dígitos) responde 400 e 529.982.247-26 (dígito verificador errado) responde 422. Valem as mesmas validações da produção.
Chave do ambiente errado (401)
Chame o sandbox com uma chave de produção (ou a produção com uma de sandbox) para ver o 401 com o código WRONG_ENVIRONMENT.
Limite de requisições (429)
O limite por segundo do seu plano vale também no sandbox. Envie mais requisições em paralelo do que o limite para ver o 429 e o cabeçalho Retry-After.

Lote misto

Este lote reúne seis situações: três CPFs encontrados, um não encontrado, um com falha do provedor e um com dígito verificador inválido. No resumo, espere found 3, not_found 1, invalid 1 e errors 1.

cURL

1curl -X POST https://api-sandbox.brazid.com/v1/cpf/batch \2 -H "x-api-key: $BRAZID_API_KEY" \3 -H "Content-Type: application/json" \4 -d '[{"cpf":"529.982.247-25","birthdate":"1982-11-26"},{"cpf":"300.000.001-16","birthdate":"1993-09-17"},{"cpf":"300.000.003-88","birthdate":"1958-07-08"},{"cpf":"000.000.001-91","birthdate":"1980-01-01"},{"cpf":"999.999.990-50","birthdate":"1980-01-01"},{"cpf":"529.982.247-26","birthdate":"1982-11-26"}]'

summary

1{2 "summary": {3 "found": 3,4 "not_found": 1,5 "invalid": 1,6 "errors": 1,7 "insufficient_credits": 08 }9}