Sandbox

Pruebe la integración sin gastar créditos y sin depender de datos reales.

Una colección con todas las solicitudes de esta guía. En Insomnia, importe el archivo y complete api_key en el entorno.

La dirección es https://api-sandbox.brazid.com. Las rutas, los parámetros y las respuestas son los mismos de producción.
Use una clave de sandbox: en el panel, en Claves de API, elija el entorno Sandbox al crear la clave. Empieza con brz_test_. Una clave de sandbox no funciona en producción, y una de producción no funciona en el sandbox (401 con el código WRONG_ENVIRONMENT).
Ninguna consulta consume crédito. credits_remaining muestra el saldo real de su cuenta, que no cambia.
Solo los CPF de prueba de la tabla de abajo tienen datos. Cualquier otro CPF válido responde 404, y la fecha de nacimiento debe ser la de la tabla.
Cada consulta demora cerca de 400 ms, para que vea el comportamiento de su código con una API real. Uno de los CPF demora 3 segundos, para probar timeouts.
Rigen los mismos límites de solicitudes por segundo de su plan. Los lotes y el webhook batch.completed también funcionan.
Toda respuesta trae el encabezado 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}

CPF de prueba

CPF	Fecha de nacimiento	Qué pasa
Consultas exitosas
529.982.247-25	1982-11-26	Titular regular, respuesta rápida.
111.444.777-35	1990-05-02	Titular regular, respuesta rápida.
300.000.001-16	1993-09-17	Titular regular.
300.000.003-88	1958-07-08	Nombre largo con acentos y apóstrofo (D'ÁVILA).
300.000.004-69	2012-10-03	Titular menor de edad.
Situación cadastral
100.000.001-08	1988-01-15	Situación cadastral SUSPENSA.
100.000.002-80	1995-12-09	Situación cadastral PENDENTE DE REGULARIZAÇÃO.
100.000.003-61	1969-06-21	Situación cadastral CANCELADA DE OFÍCIO.
300.000.002-05	1984-02-29	Situación cadastral NULA.
Datos incompletos o distintos
390.533.447-05	1976-08-30	Campo opcional nulo: situation viene null.
Respuesta lenta
200.000.001-08	1991-04-04	Respuesta lenta, de 3 segundos.
400.000.001-24	1987-12-01	Respuesta muy lenta, de 9 segundos, para agotar timeouts.
Errores
000.000.001-91	1980-01-01	CPF válido sin registro: 404.
999.999.990-50	1980-01-01	Falla simulada del proveedor: 503 (en el lote, el elemento viene con estado error).

Los nombres y las fechas son ficticios. Si la fecha enviada no es la de la tabla, la respuesta es 404, como en producción.

Escenarios de prueba

Flujo normal
Consulte 300.000.001-16 con la fecha de la tabla y confirme que su integración lee name, birthdate y situation.
Titular no encontrado (404)
Consulte 000.000.001-91, cualquier CPF válido fuera de la tabla o un CPF de la tabla con otra fecha de nacimiento. El 404 es un resultado normal: su sistema no debe tratarlo como falla.
Proveedor no disponible (503)
El CPF 999.999.990-50 siempre responde 503. Úselo para probar el reintento con espera creciente y el aviso al usuario. En el lote, el elemento vuelve con estado error.
Respuesta lenta y timeout
El CPF 200.000.001-08 demora 3 segundos y el 400.000.001-24 demora 9. Con el timeout de su cliente HTTP en 5 segundos, el primero debe pasar y el segundo debe agotarse.
Situación cadastral
Los CPF 100.000.001-08, 100.000.002-80, 100.000.003-61 y 300.000.002-05 vuelven con situaciones distintas de REGULAR. Pruebe si su sistema bloquea o señala a esos titulares.
Campos nulos
El CPF 390.533.447-05 devuelve situation null. Asegúrese de que su código no falle con null.
Acentos y menores de edad
El CPF 300.000.003-88 tiene nombre largo con acentos y apóstrofo, y el 300.000.004-69 es de un menor de edad. Revise la codificación UTF-8 y sus reglas de edad.
CPF mal formado (400 y 422)
No necesita la tabla: 1234567890 (10 dígitos) responde 400 y 529.982.247-26 (dígito verificador incorrecto) responde 422. Rigen las mismas validaciones de producción.
Clave del entorno equivocado (401)
Llame al sandbox con una clave de producción (o a producción con una de sandbox) para ver el 401 con el código WRONG_ENVIRONMENT.
Límite de solicitudes (429)
El límite por segundo de su plan rige también en el sandbox. Envíe más solicitudes en paralelo que el límite para ver el 429 y el encabezado Retry-After.

Lote mixto

Este lote reúne seis situaciones: tres CPF encontrados, uno no encontrado, uno con falla del proveedor y uno con dígito verificador inválido. En el resumen, espere found 3, not_found 1, invalid 1 y 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}