Validador de Número de Documento

Verifique si un número de documento está bien formado para su jurisdicción, antes de crear una sesión o enviar una verificación. No se almacena nada y no se consume ninguna verificación.

Endpoint: POST /v1/validators/document-number
Autenticación: token Bearer con el scope sessions

Una verificación de formato sin estado contra el mismo registro que usa el pipeline de verificación. No se almacena nada y no se consume ninguna verificación — pero recibe identificadores gubernamentales, por lo que se atribuye a un tenant como todos los demás endpoints de esta sección. Útil para validar la entrada en su propio formulario antes de crear una sesión.

curl --request POST \
  --url https://{FQDN}/v1/validators/document-number \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "documentType": "drivers_license",
  "number": "31612967",
  "issuingCountry": "USA",
  "issuingState": "PA"
}'

{
  "documentType": "drivers_license",
  "issuingCountry": "USA",
  "issuingState": "PA",
  "valid": true,
  "rule": "drivers_license:USA:PA",
  "detail": "document number matches the PA license format"
}

El número que envía nunca se devuelve en la respuesta. La respuesta informa la jurisdicción aplicada, no el identificador que usted envió.

Qué Está Cubierto

Los 11 países adicionales de pasaporte, como el issuingCountry que usted envía: ARG, AUS, CHN, DEU, FRA, GBR, IND, ITA, JPN, NLD, RUS.

Todo lo que no está marcado con ✓ — dentro o fuera de la tabla — devuelve valid: null, nunca false. Trate null como "no lo sabemos": acéptelo, y no lo interprete como aprobación ni rechazo.

La CNH, el CPF y el DNI/NIE se verifican con aritmética real de dígitos de control, por lo que una transposición de dígitos se detecta — a diferencia de las tablas de licencias, que verifican solo la forma, porque esas jurisdicciones no publican dígito de control.

Indicar la Jurisdicción

issuingCountry es el país — un código ISO 3166-1 alpha-3, un nombre de país o un alias común. issuingState es una subdivisión dentro de ese país — un estado de EE. UU. o una provincia o territorio de Canadá — y solo las licencias de conducir la utilizan.

Una subdivisión debe nombrar su país. Enviar issuingState sin issuingCountry hace que la solicitud sea rechazada sea cual sea el tipo de documento, porque PA por sí solo puede ser Pennsylvania o Pará, y la respuesta nombraría una jurisdicción que usted nunca indicó. ssn e itin son la excepción — su país nunca está en duda. No enviar ninguno de los dos está permitido y devuelve valid: null — no verificable, no inválido. Nada infiere el país: un pasaporte o cédula de identidad sin él también devuelve valid: null.

ssn e itin existen solo en el validador. No son tipos de documento capturables — no puede crear una sesión para ellos — pero las reglas estructurales son útiles cuando los recoge en sus propios formularios.

Interpretar la Respuesta

valid es deliberadamente de tres valores:

Un false exige una prueba. La CNH, el CPF, el DNI/NIE, el SSN y el ITIN llevan una, y un valor que ninguna jurisdicción podría emitir — puntuación en un número de licencia, una forma fuera de la genérica ICAO para un pasaporte — queda refutado de entrada.

Un número de licencia o pasaporte que simplemente no coincide con ninguna de las formas que mantenemos para su jurisdicción devuelve null, no false. Esas tablas reconocen formas; no las verifican, y son incompletas de maneras que los documentos reales siguen encontrando. Maryland emite un número con prefijo MD junto al antiguo, y Massachusetts un prefijo de dos letras; cada uno faltaba hasta que una licencia genuina fue rechazada por él. Responder false allí le decía al integrador que un documento válido era inválido.

rule nombra la regla aplicada, para que sepa qué jurisdicción respondió:

Cada regla nombra el documentType al que pertenece, por lo que el prefijo corresponde al tipo por igualdad de cadena. La única excepción es un valor reservado de sandbox, con prefijo reserved: y el tipo en su segundo segmento — vea Sandbox y Datos de Prueba.

Errores

Próximos Pasos

• Sesiones de Verificación — crear una sesión, y el prefill que usa esta misma verificación
• Sandbox y Datos de Prueba — números reservados que devuelven un veredicto elegido bajo demanda