HTTPS POST method to create a new verification. You will receive a Verification UUID Identifier,
which you should store and use to check verification status and request verification results when they are ready.
\nNote: If the verification does not require the back of the document or the selfie, this field should be removed from the request.
\n"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"uuid\": \"uuid\"}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/id/v2/status","description":"Get Verification Status
\nUse to check verification status and request verification results when they are ready.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| id/status | \nPOST | \n
\n\n
\n
Request Parameters - Body (Json)
\n\n\n\n| Parameter | \nValue | \n
\n\n\n\n| uuid | \nuuid obtained in the previous step,
when sending the images to verify. | \n
\n\n
\n
Response
\n\n\n\n| HHTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nVerification Status | \nWaitingChecking: waiting for verification checking
ManualIdentification: verification under reviewer identification
ManualChecking: verification under reviewer checking
| \n
\n\n| 401 | \n | \nUnauthorized, invalid token | \n
\n\n| 400 | \nError Message | \nTransaction not found | \n
\n\n
\n
Get Verification Results
\nUse to check verification Results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| id/results | \nPOST | \n
\n\n
\n
Request Parameters - Body (Json)
\n\n\n\n| Parameter | \nValue | \n
\n\n\n\n| uuid | \nuuid obtained in the firts step,
when sending the images to verify. | \n
\n\n| includeImages | \nReturns the cropped verified images | \n
\n\n
\n
Response
\n\n\n\n| HHTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson VerificationResultsObject | \nVerificatonResults object with document data and verification checks performed | \n
\n\n| 401 | \n | \nUnauthorized, invalid token | \n
\n\n| 400 | \nError Message | \nTransaction not found | \n
\n\n
\n
Create a Verification
\nHTTPS POST method to create a new verification. You will receive a Verification UUID Identifier,
which you should store and use to check verification status and request verification results when they are ready.
\nRequest JSON
\n\n\n\n| Name | \nDescription | \nType | \n
\n\n\n\n| id* | \ndefined by user, must be string. | \nstring | \n
\n\n| options | \nObject that is used to customize the verification. | \nOptionsInterface | \n
\n\n
\n
OptionsInterface
\n\n\n\n| Name | \nDescription | \nType | \n
\n\n\n\n| checks | \nAn object to specify additional verifications | \nChecksInterface | \n
\n\n| redirect_url | \nUrl to redirect when the process finished. | \nstring | \n
\n\n
\n
ChecksInterface
\n\n\n\n| Name | \nDescription | \nType | \n
\n\n\n\n| selfie/ | \nChoose if the verification has selfie. | \nboolean | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nUUID | \nUUID generated correctly | \n
\n\n| 400 | \nJson ErrorMessage object | \nBad Request | \n
\n\n
\n
Validate CURP
\nHTTPS POST method to create a new validation.
You will recive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/curp | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\n| id | \nstring/number | \nHelps you to identify the validation | \n
\n\n| curp | \nstring | \n18 CURP digits to validate | \n
\n\n
\n
Response - Body (Json)
\nSuccessful response with valid CURP
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| curp | \n18 digits of the person's CURP | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \nOK | \n
\n\n| codigoMensaje | \n\"0\" | \n
\n\n| nombre | \nPerson´s name | \n
\n\n| apellidoPaterno | \nPerson's paternal surname | \n
\n\n| apellidoMaterno | \nMaternal last name of the person | \n
\n\n| sexo | \nSex of the person {\"HOMBRE\" | \n
\n\n| estadoNacimiento | \nState of born | \n
\n\n| paisNacimiento | \nCountry of born | \n
\n\n| fechaNacimiento | \nBirth of born | \n
\n\n
\n
Nota: There is additional data from the evidentiary document, which may or may not come depending on the case.
\nSuccessful response with invalid or non-existent CURP in RENAPO
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"CURP no valido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"1\" | \n
\n\n
\n
\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"CURP con formato invalido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"2\" | \n
\n\n
\n
Successful response with CURP not valid per validation digit
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"CURP no valido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"3\" | \n
\n\n
\n
Successful response with error due to unavailability of RENAPO
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"RENAPO no disponible\" | \n
\n\n| codigoMensaje | \n\"4\" | \n
\n\n
\n
Successful response with error in the data sent
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"Error de datos\" | \n
\n\n
\n
Validate INE/IFE
\nHTTPS POST method to create a new validation.
You will recive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/ine | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| id | \nID helps you to identify validation | \n
\n\n| cic | \nCIC number of the voter card | \n
\n\n| ocr | \nOCR number of the voter card | \n
\n\n| claveElector | \nElector key | \n
\n\n| numeroEmision | \nIssuance number of the voter card | \n
\n\n| identificadorCiudadano | \nCitizen identifier number | \n
\n\n
\n
\n- identificaforCiudadano: Mandatory if it is INE
\n- claveElector & numeroEmision: Mandatory if it is type A, B or C
\n- ocr: Mandatory if it is IFE
\n- cic: Mandatory if it is type D, E of F
\n- identificadorCiudadano: OCR number of the document without the first 4 numbers
\n
\nResponse - Body (Json)
\nSuccessful response with INE/IFE valid as identification to vote
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"Está vigente como medio de identificación y puede votar\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Ok\" | \n
\n\n| claveMensaje | \n\"3\" | \n
\n\n| claveElector | \nVoter key number | \n
\n\n| numeroEmision | \nCredential issue number | \n
\n\n| anioRegistro | \nVoter registration year | \n
\n\n| anioEmision | \nYear of issuance of the credential | \n
\n\n| vigencia | \nValidity of the credential | \n
\n\n| ocr | \nCredential OCR | \n
\n\n
\n
Successful response with INE/IFE as identification and not to vote
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"Está vigente como medio de identificación y no puede votar\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Ok\" | \n
\n\n| claveMensaje | \n\"2\" | \n
\n\n| claveElector | \nVoter key number | \n
\n\n| numeroEmision | \nCredential issue number | \n
\n\n| anioRegistro | \nVoter registration year | \n
\n\n| anioEmision | \nYear of issuance of the credential | \n
\n\n| vigencia | \nValidity of the credential | \n
\n\n| ocr | \nCredential OCR | \n
\n\n
\n
Successful response with INE/IFE invalid due to incorrect data
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"Datos incorrectos o inexistentes\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Error\" | \n
\n\n| claveMensaje | \n\"0\" | \n
\n\n
\n
Successful response with INE/IFE invalid as identification and invalid to vote
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"No esta vigente como medio de identificación y no puedes votar\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Error\" | \n
\n\n| claveMensaje | \n\"1\" | \n
\n\n| claveElector | \nVoter key number | \n
\n\n| numeroEmision | \nCredential issue number | \n
\n\n| anioRegistro | \nVoter registration year | \n
\n\n| anioEmision | \nYear of issuance of the credential | \n
\n\n| vigencia | \nValidity of the credential | \n
\n\n| ocr | \nCredential OCR | \n
\n\n
\n
\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"CIC con formato no valido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Error\" | \n
\n\n| claveMensaje | \n\"5\" | \n
\n\n
\n
\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"OCR con formato no valido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Error\" | \n
\n\n| claveMensaje | \n\"6\" | \n
\n\n
\n
Successful response with invalid voter key
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"Clave de elector con formato no valido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Error\" | \n
\n\n| claveMensaje | \n\"7\" | \n
\n\n
\n
Successful response with invalid issue number
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"Número de emisión con formato no valido\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \n\"Error\" | \n
\n\n| claveMensaje | \n\"8\" | \n
\n\n
\n
Successful response with error in the data sent
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"Error de datos\" | \n
\n\n| claveMensaje | \n\"4\" | \n
\n\n
\n
Unsuccessful response by username and/or password
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"Error de autenticacion\" | \n
\n\n
\n
Get NSS
\nHTTPS POST method to create a new validation.
You will recive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/nss | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| id | \nId to helps you to identify response | \n
\n\n| curp | \n18 digits of the CURP from which you want to obtain the NSS | \n
\n\n| email | \nEmail registered in the person's IMSS | \n
\n\n
\n
Response - Body (Json)
\nSuccessful response with NSS found
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| nss | \nNSS obtained | \n
\n\n| nombre | \nThe name of the person | \n
\n\n| curp | \nThe CURP of the person | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| estatus | \nOk | \n
\n\n| codigoMensaje | \n0 | \n
\n\n
\n
Successful response with a non-positive message from the IMSS
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"No se encontro un numero asociado al CURP\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n1 | \n
\n\n| estatus | \nERROR | \n
\n\n
\n
Successful response with number of operations exceeded
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"El numero de operaciones por periodo ha sido alcanzada (2 operacion(es) cada 1 dia(s)),
favor de intentar mas tarde\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n2 | \n
\n\n| estatus | \nERROR | \n
\n\n
\n
Successful response with email already used by another CURP
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| Mensaje | \n\"El correo electronico que capturo ya se encuentra registrado en el Instituto relacionado a una CURP distinta a la capturada\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n3 | \n
\n\n
\n
Successful response with CURP not found in RENAPO
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| Mensaje | \n\"No se localizó información en RENAPO con la CURP capturada\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n4 | \n
\n\n
\n
Successful response with error in the data sent
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"Error de datos\" | \n
\n\n
\n
Successful response with error due to IMSS unavailability
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| Mensaje | \n\"IMSS no disponible\" | \n
\n\n
\n
Unsuccessful response by user and/or password
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"Error de autenticacion\" | \n
\n\n
\n
Validate RFC
\nHTTPS POST method to create a new validation.
You will recive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/rfc/validate | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| id | \nId whatever you want. It helps you to identify validation. | \n
\n\n| rfc | \n12-13 digits of the RFC to validate | \n
\n\n
\n
Response - Body (Json)
\nSuccessful response with valid RFC
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"RFC Valido\" | \n
\n\n| codigoMensaje | \nUnique validation execution code.
The key to this code is keeping a record of requested validations. | \n
\n\n| estatus | \nOk | \n
\n\n| topoPersona | \nNatural or legal person {\"F\" or \"M\"} | \n
\n\n
\n
Successful response with RFC not in force but registered with the SAT
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"El RFC ingresado no se encuentra en la lista de RFC no cancelados\" | \n
\n\n| codigoMensaje | \nUnique validation execution code.
The key to this code is keeping a record of requested validations. | \n
\n\n| codigoError | \n0 | \n
\n\n| estatus | \nERROR | \n
\n\n
\n
Successful response with invalid RFC
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| mensaje | \n\"El RFC ingresado no se encuentra en la lista de RFC no cancelados\" | \n
\n\n| codigoMensaje | \nUnique validation execution code.
The key to this code is keeping a record of requested validations. | \n
\n\n| codigoError | \n1 | \n
\n\n| estatus | \nERROR | \n
\n\n
\n
\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"RFC con formato invalido\" | \n
\n\n| codigoMensaje | \nUnique validation execution code.
The key to this code is keeping a record of requested validations. | \n
\n\n
\n
Successful response with error in the data sent
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"Error de datos\" | \n
\n\n
\n
Successful response with error due to non-availability of the SAT
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"SAT no disponible\" | \n
\n\n
\n
Unsuccessful response by user and/or password
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"Error de autenticacion\" | \n
\n\n
\n
Colombian citizen card
\nHTTPS POST method to obtain an identity document (card) issued by the Entity. \nThe status certificate is the mechanism by which the Colombian National Registry, after verification in the databases of the Identification system, informs citizens about the status of an identity document (card) issued by the Entity.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| id* | \nint | \n11 | \n
\n\n| numeroIdentificacion* | \nstring | \n6322089 | \n
\n\n| fechaNacimiento* | \nstring ($dd-MM-YYYY) | \n25/07/2001 | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nCitizen card in base64 and info about it | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Validate IMSS Work History
\nHTTPS POST method to create a new validation.
You will recive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/imss | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\n| id | \nstring/number | \nHelps you to identify the validation | \n
\n\n| nss | \nstring | \n10 NSS digits to validate | \n
\n\n| curp | \nstring | \n18 CURP digits to validate | \n
\n\n
\n
Response - Body (Json)
\nSuccessful response
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| nombre | \nPerson's name | \n
\n\n| semanasCotizadas JSON Object | \nsemanasCotizadas
semanasReintegradas
semanasDescontadas | \n
\n\n| historialLaboral Objects array | \nfechaAlta
fechaBaja
salarioBaseCotizacion
entidadFederativa
nombrePatron
registroPatronal | \n
\n\n| estatus | \n\"OK\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| claveMensaje | \n\"0\" | \n
\n\n
\n
Successful response with invalid or non-existent NSS in IMSS
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"“El NSS XXXXXXXXXX no fue localizado en el IMSS.\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"1\" | \n
\n\n
\n
Successful response with invalid or non-existent CURP in RENAPO
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"La CURP proporcionada no fue localizada en la entidad externa RENAPO\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"2\" | \n
\n\n
\n
Successful response with error: Captured NSS does not match CURP
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"El NSS capturado no coincide con la CURP\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"3\" | \n
\n\n
\n
Successful response with error: At the moment it is not possible to deliver a constancy
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"Por el momento no es posible entregarle su constancia por favor intente mas tarde o solicitela directamente en la Subdelegación mas cercana a su domicilio en días y horas habiles.\" | \n
\n\n| codigoValidacion | \nUnique validation execution code.
The purpose of this code is to keep a record of requested validations. | \n
\n\n| codigoMensaje | \n\"4\" | \n
\n\n
\n
Successful response with error: There is missing data in the petition
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"Hay datos faltantes en la peticion\" | \n
\n\n| codigoMensaje | \n\"5\" | \n
\n\n
\n
Successful response with error trying to get the page information
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"Error\" | \n
\n\n| mensaje | \n\"Ocurrio un error a tratar de obtener la información de la página\" | \n
\n\n| codigoMensaje | \n\"6\" | \n
\n\n
\n
Validate CPE
\nHTTPS POST method to create a new validation.
You will receive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/cpe | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\n| id | \nstring/number | \nHelps you to identify the validation | \n
\n\n| ced | \nstring | \nProfessional License ID | \n
\n\n
\n
Response - Body (Json)
\nSuccessful response with valid CURP
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| error | \nIndicates 1 if there is an error or 0 otherwise | \n
\n\n| result JSON Object | \nResults object with all information about CPE
Object:
cedula
institucion
nombres
apellidoPaterno
apellidoMaterno
sexo
tipo
titulo | \n
\n\n| message | \nIf error is \"1\", field message will indicate the cause | \n
\n\n
\n
Nota: There is additional data from the evidentiary document, which may or may not come depending on the case.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","name":"VeriDocID API Docs old","type":"collection"}},"urlObject":{"protocol":"https","path":["api","gov","cpe"],"host":["veridocid","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"20b3325c-e497-4bc9-940f-559ac8452336","name":"200 - Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01\",\n \"curp\": \"CURP\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/gov/cpe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Fri, 24 Apr 2020 07:23:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"estatus\": \"OK\",\n \"codigoValidacion\": \"\",\n \"curp\": \"\",\n \"nombre\": \"\",\n \"apellidoPaterno\": \"\",\n \"apellidoMaterno\": \"\",\n \"sexo\": \"\",\n \"fechaNacimiento\": \"\",\n \"paisNacimiento\": \"\",\n \"estadoNacimiento\": \"\",\n \"docProbatorio\": \"\",\n \"datosDocProbatorio\": {\n \"anioReg\": \"\",\n \"municipioRegistro\": \"\",\n \"tomo\": \"\",\n \"libro\": \"\",\n \"numActa\": \"\",\n \"foja\": \"\",\n \"entidadRegistro\": \"\",\n \"claveEntidadRegistro\": \"\"\n },\n \"codigoMensaje\": \"0\",\n \"documento\": \"\"\n}"},{"id":"a0b3718c-9077-4210-8b84-9a6d5d34cfff","name":"200 - Error - No Valido","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01\",\n \"curp\": \"CURP-No-Valido\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/gov/curp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Fri, 24 Apr 2020 07:25:55 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"estatus\": \"ERROR\",\n \"mensaje\": \"CURP no valido\",\n \"codigoValidacion\": \"vc1587713155.8598726\",\n \"codigoMensaje\": \"3\"\n}"},{"id":"7ee38968-8ffb-452f-9262-91704585141f","name":"200 - Error - Formato No Valido","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01\",\n \"curp\": \"CURP-Formato-no-valido\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/gov/curp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Fri, 24 Apr 2020 07:24:35 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"estatus\": \"ERROR\",\n \"mensaje\": \"CURP con formato invalido\",\n \"codigoValidacion\": \"vc1587713076.0470695\",\n \"codigoMensaje\": \"2\"\n}"},{"id":"700c1ed5-7247-4044-add0-012ed2c55ff6","name":"200 - Error - RENAPO No Disponible","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"01\",\n \"curp\": \"PEAJ890808HDFRLN12\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/gov/cpe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Fri, 24 Apr 2020 07:25:55 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"estatus\": \"ERROR\",\n \"mensaje\": \"RENAPO no disponible\",\n \"codigoValidacion\": \"vc1587713155.8598726\",\n \"codigoMensaje\": \"4\"\n}"}],"_postman_id":"69975cdb-f1df-4d4a-af78-ebbd0900357e"},{"name":"12 - Opinion de Cumplimiento","event":[{"listen":"test","script":{"id":"cbf5a58e-ae13-48ed-b716-c5950a8895bd","exec":[""],"type":"text/javascript"}}],"id":"aa400c01-3a89-4b88-9399-0ce6df2a13e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"string\",\n \"rfc\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/gov/oc","description":"Opinion de cumplimiento
\nHTTPS POST method to create a new validation.
You will recive a Json response with the results.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| gov/oc | \nPOST | \n
\n\n
\n
Request Parameters
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\n| id | \nstring/number | \nHelps you to identify the validation | \n
\n\n| rfc | \nstring | \nRFC | \n
\n\n| password | \nstring | \nPassword | \n
\n\n
\n
Response - Body (Json)
\nSuccessful response with valid RFC and Password
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| base64 | \nFile in base64 | \n
\n\n
\n
Successful response with error due to unavailability of SAT
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"SAT no disponible\" | \n
\n\n| codigoMensaje | \n\"1\" | \n
\n\n
\n
Successful response with lack of RFCs in the request
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| estatus | \n\"ERROR\" | \n
\n\n| mensaje | \n\"RFC con formato invalido\" | \n
\n\n| codigoMensaje | \n\"2\" | \n
\n\n
\n
Analyze receipt of Residence
\nThe image is sent to be processed.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| ocr/analyze | \nPOST | \n
\n\n
\n
Request Parameters:
\n\n\n\n| Name | \nRequired | \nDescription | \n
\n\n\n\n| id | \nyes | \nAllows you to identify the analyze | \n
\n\n| image | \nyes | \nBase64 format image | \n
\n\n| type | \nNo | \nvoucher type (CFE or Telmex) | \n
\n\n
\n
The supported image formats are:
\n\n- JPG
\n- PNG
\n- PDF (Not supported without optional parameter type)
\n
\nResponse
\nIf the status code is 200, you will receive a GUID identifier in response,
which will be used to obtain the results of the analysis.
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nGUID Format | \nValid OAuth token for request authorization | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n
\n
To obtain the results of the OCR Analysis, send the request with
the GUID obtained in the previous request in the format /results/{{uuid}}
\nIn addition to providing you with the results of the OCR analysis, we have added three more fields that will allow you to have better information about the address and about the receipt that was analyzed.
\nThe new fields are formNameModel, fullAddress and segmentedAddress (*this field is not included in the response, if you want to receive it you need to request a permission).
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON Authorization object | \nValid OAuth token for request authorization | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
The formats of Proof of Address that are supported:
\n\n- CFE
\n- Telmex
\n- Izzi
\n- Megacable
\n- Recibo de agua municipal Monterrey
\n- Recibo de gas Monterrey
\n
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c95021a5-d73b-4474-982f-63bfb44777c4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"62b2c826-9f59-41f2-a956-b47de8aba960"}}],"_postman_id":"a1e3b9d3-76c6-4389-a697-2e14762f6280","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","name":"VeriDocID API Docs old","type":"collection"}}},{"name":"Fingerprint Authentication","item":[{"name":"01 - Insert person","id":"4c25dd85-470c-4a93-bd97-9fa3af1b0f79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"idPersona\": 200,\n\t\"rightIndex\": \"Base64 FingerPrint\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/afis/insert","description":"Insert user fingerprints
\nRequests Parameters
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| idPersona | \nNumerical identifier, which is used to identify the person who is enrolled. | \n
\n\n| rigthThum | \nBase64 fingerprint | \n
\n\n| rigthIndex | \nBase64 fingerprint | \n
\n\n| rigthMiddle | \nBase64 fingerprint | \n
\n\n| rigthRing | \nBase64 fingerprint | \n
\n\n| rigthLittle | \nBase64 fingerprint | \n
\n\n| leftThum | \nBase64 fingerprint | \n
\n\n| leftIndex | \nBase64 fingerprint | \n
\n\n| leftMiddle | \nBase64 fingerprint | \n
\n\n| leftRing | \nBase64 fingerprint | \n
\n\n| leftLittle | \nBase64 fingerprint | \n
\n\n
\n
Match user fingerprints
\nRequests Parameters
\n\n\n\n| Property | \nValue | \n
\n\n\n\n| Fingerprint to verify | \nBase64 fingerprint | \n
\n\n
\n
To verify the existence in the database of a person, through their fingerprints, just send one.
No matter what (rightThumb, rightIndex, rightMiddle, rightRing, rightLittle, leftThumb, leftIndex, leftMiddle, leftRing, leftLittle)
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","name":"VeriDocID API Docs old","type":"collection"}},"urlObject":{"protocol":"https","path":["api","afis","match"],"host":["veridocid","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"17e1df8c-6ffa-491a-b856-d133dd487a4f","name":"200 - NO HIT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"rightThumb\": \"/6D/qAB6TklTVF9DT00gOQpQSVhfV0lEVEggMjg4ClBJWF9IRUlHSFQgMzUyClBJWF9ERVBUSCA4ClBQSSA1MDAKTE9TU1kgMQpDT0xPUlNQQUNFIEdSQVkKQ09NUFJFU1NJT04gV1NRCldTUV9CSVRSQVRFIDAuNzUwMDAw/6gAAv+kADoJBwAJMtMlzQAK4PMZmgEKQe/xmgELjidkzQAL4XmjMwAJLv9WAAEK+TPTMwEL8ochmgAKJnfaM/+lAYUCACwDrMsDz1oDrMsDz1oDrMsDz1oDrMsDz1oDvqYD5MgDvBED4a4DtaAD2fMDwcgD6IoDv4kD5dcDsHQD074DrVQDz/4Dth0D2okDqFwDyggDn6cDv5UDl2UDta0DpXEDxogDp8YDyVQDoPYDwScDpL0Dxa8DyrID8zwD1r8CGcUDt7QD3HED2NkCGgYD4OoCGv0D9FACHVED4r8CGzYD+7ACHjQDw1ID6mID3AoCGmgDygkD8nEDze0D9xwD8HMCHNsD/JMCHk8D3FICGnAD9tACHZ4DnoADvjMDqkwDzFsD0QoD+tkDxGsD67MDs1ED1y8Dw50D6rwD0tUD/QAD1BAD/noD1mwCGbsD0vcD/SkD5poCG6wD5MoCG3QD3VQCGo8D1VgCGZoD5m8CG6cD6PICG/QD+B0CHcYD5RUCG30CKFgCMGkD8gsCHQwCNPoCP5MD0zED/W8D63YCHEECIgQCKNICMIwCOkEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/ogARAP8BYAEgAk8OBD3DAAAA/6YAZwAAAAUCAwIGCQoKExEBAAAAAbKztbaxtwKwuK+5A62uuru8BAWqq6y9vsDBBgcIpaapv8PLzAkKCwwNpKfCxcoODyErLUCQl5ucnp+hoqjExsfJEBMcICIuMDU8kZOWmJqdo83I/6MAAwD5/P5fL5fL5/P5/P5/P/8Afh8/l8vn8vx68e/r8fx+f/3lS40j/b8a9vt/f7s34+fh7f3fr+2r18Pu/wCv+P8An9v3eHTy/d+z9X6/+/497+//AM/b+r/f9nu4r/7l+37f1/v7th8v7b8uS5+P4fW4uCGs4TF0hLKTjq4uXXwsRJn4cdRkZvn37qsZPXv0Duit90qbx4hu00NYSC7bRbWFA8y2GxcEx0oOtwlVbXqEczLu02KW3NtCC+IzlYXh4bcsFnr+P4enn4zgl7GuzOw1KjRRsRhDVZLSE6ELaxCGSXixRVBWLtw0gucFOrZZhYP52/sKQph+x3IFCE/WSHg01q+2RUKYM0GZhsa54JQUYbxRVs5DdvEidVKURiwU9hMEhYsW8PCyipBeFmlbiTwuEQtNu9KBTgpmnh2CG4VI7RKU01BCiTLxHe4Tg1iREIjm8RpRp1Ao+YOFQmRG+BsWHlB2ew9i4QG2iw4/Ywj+Z/kWGw/oaqsug1621kHc3AvVbsh3VIKX2OCTDpmS+CG+bmLiIYOEKVajY2ToEGi2HvFfBLTWLKwdkdVBHgsMTCUpsxhBPgU2sKnLhuqFBrRpBto2FJgwUmKBtJ1pvT0JBkEl4TMMbDN0LpXh825XDnUisNGNl8LY2qHooW8rtmr1TKuQPtSSSSSX+CX2NCp9ay1reU364FID9KbGpYVh6C4LJmNEETUXBZ6TiCUi16nd53FsNViAlIbxCw8TbBQNTSUoLTqlg2m2NCqeNJhWqwwaIzL1AUc8KqIMRuBS5uX01vqyuCnM1eunj01zMyYNwXtts+vjzJslhqqM5+npouXOFvlbv089+W16EwQzHZ0j0Y16k3a24u5+lT7Egm39LZVqIP2JRIOBx9sLjEZJYPBnsgfAm+xJUVdKwk6whILiCjYsQElPKgo6DYQKThMZcREZploRJYSFJaCTkaYy2CFl3FUwwTaPrQ0U4hlO7bsStrCTiDLdAxwiFK0iDCM6jaPBBYS0GkI7xO1NHCTLb+hf6v7ECcIP2Ns3wX0xUyCG2+3IjKTI3LeGbSsOE1aVLhTBQOGuCCBTTShxTQZNQsK4GpTQQdRolBYgTNIFBWxLQWLUIIqNLBCefDOmLdWWWHw6dNthxVvGbwzM+Hl5/h6e7i6CaZbm/LPP+qnBqYYPt9vf4irKV0yHjr4c+r1y00cHsWNk9BjVP2N8H/ivywR/XVNxtv2N5dJpYXaqShyKOHO3jyaKTBgfZBMWU3N1l8KDGocKYVIbXVrRSw3crFAibiUw5YLeQRCmhZQ1ktXy3qo0ysi7JF+E8PHQYpnWdwnBrO/kkc54pqUaso9IPHddy55SMyLrnXx+Pw8u5TfO8DF6zr+nXnrbVc++B6km3iOfS9n4a4Kw2C9aCREXYnNlAp+lCF/USUFwnso1ToHD9TctWxAxPVpBYqxnInCxHHu7JifaUYmJimyxsog2DCiI4M9yYU0EpQSxy48YmsNPlHUR6ZoNSOIJhMffn36TgQVDMQXv/wDdvLfzgSZ1x1tCfLzfj493XFmaFxfhO8K8gtHp08PLZ8uKa3/DuTx1m2tsdM33e3n4+AN6a7KWvP3/AMPiY7edV6t5s1YIXsQf5lh/YnVNBfUi1Al628ZG0l6fqet4qGzxl3webzHmoVC5wSayxebEgaCBxoimlMIMJOO65TMQItpEF1q76JJrBsKIKTDDYK1TzFW2zxdC8Nrs682S2QhbQQvYtDJhaZ1cBGixFDA6dNtYNrUqxMaLL04Eheeywk9BkiJYIKYMaphv1JiN4Yf50KX2LRWvqbTxkq7fqlp2c4vPrPKafeeePGI4RUracgsZEWHbz03zbYzsyUDTZrTLFKWN8OZG4aEEtZwnGySRNbZvpp1SQzBKyKGb1okiuO2JyzEMrB0D0/n455dej0CnwZxrr8PLy5y95SRekhy9vdtbNvKQeGOPHu7jcIKeEKGa8Pt94sPnh6SsV3fx5efjzWyDahOr+7l6b+G3sRQ1uMpflf8AnEvyMdPh59D9SS/rz8Lyp6+PNcvh7fuzzyS+wjOl0+3ad/Xam8JHWl9/2m62hS4RWr1tu+nGU4GKCvT/AIHO4b4hCY1zYnLu5sE5w08Z8vj5eFCUOYTVN18M+dbhiqDq7NPpryyQrwgxaC2+MBo0ksJhqe7wgq5SKuBoRQtjlvMGjiE8DSp2GwhDwjab4R07gVJzLfagVhwEVPof+S/IrVz63exqkm/ZB37hRDNdr3zvXMTv329CF2/fv/Lrm3Kz8fS8Pn5b9/ULjz7/AD7u+RhPy+H9NVd/D+Od+Xv8A5K6fz471y6+/j5b89yEHp8eMuvP+Hv2wwnRuvu4vb0RuZyKOnXT3bL4L3RuYjXLWe/07/L8NIONixRevDy93ftKCeFFg649bnBC0iXjKKQeNMVhyjN8FpGsNqwhaaM1piuTZTg0Tnbwr1S7HEX1WF9MgX6E7f5UkxAvUm2wY0V6kSNApXHOxVercCE53sLxBtSeFjk4CxUkV1HYTsOhYR5uMUqFHMDzJTtGra5o8Wtd252wyzO/Xi6M0PDz1Quc+PT7um5Mvw66yhnu99514dKDClbeA8/Pqj14jmkGsZnT4fzhXTu5oMMSuV68etHrkKhYQrn03UGb32Cmkk9dRxUHK8MKyNd5LvnzfqaFrKaK+lN/6LEWH9CYIbYv1vaw0W0G+24hKG4iUWEFoNrEZCWJtMm2FwgbQqUrMTTxUtqe7miIIGmgsi39ohDTVC2dzPvpZ3WHlgtCLfz9/wB/fLTDoWFKfXjy74F2c/f5cdAjO3eoGHp+nLplZJKBYoZ6V4deQfMLHKBTPl7rSDIYSoF3Pu6cdBY3yd1SSS3Lw8HuuZiSa9ZUTSbD/wBl/dJdFfSh16BLCv1zlNwz2TnOxcqDgeLqRYi76PIhSu/jt4d+F8enE6mRpLpvPHF8fTm+RIcrM+HIuc9t681g6WeiOk3n7+++pSO3xrwadCe/z59Mbz0qt0g5XXjy5Gs77J3hJPM52o1qZLEbaxUKCq5ilhoaG7YsONtiJYKxkJN4uBK8lDWt0cEsFCGA541O1MHp4w3rT+hhcF+hoP7G8N/S0kQcNLtdcyo2bEPqgYjNoZuohCHWQmEedKIKLO8jwxm7SFjSwmYFZK5iA+/z43UmJvy+HFsP4/y6Z3dZtd7zuDl7DrmCV5cvLkEGo+VJpOvT37ktPFsyBX3+mGWLBRODsMpiJNJRhwKXmYrsUeqhWDhssLBHPO+jwRvhA9baqMvtgQJlFlf3/wD/pgCHAQACAQEEBAUHCxMYERUAAACztQECAwSytgUGB7EICQqwtwsMDQ4PabgQERITFhccaq+5uxQVGBkaHR8gISMnKy2sra66vL0bHiIlJiwuLzIzNj0+P0FCQ0RFTVCpqr4kKCkqMTQ5OkBHV1mipKanwDU3ODxGSUxOUVRWWl9gYmNkqL/Bw/+jAAMB++9iMepxTW8xwKTLWOTnJhCZyXZiziENGZ+lBjM6BQsyQyZMWHekGg6UzKhghhSIYtmZDO8xGnIEIhdrHPGEjTjN1z4PT1vMs5iBPVz39Xr+ssbxV3/h/wC/3/w9XqGsQmWZ6Y/edGZXOY4t9X8fD1Yd8QodM+vpOeBoj+0YL1JMpCPFaxHkEMmM1h1Iq5wi40ZmgXENsVmzByUrAUsQjEs1mMxSOLOWKAwrMSwvDFmMYUwY1hjBjTBHfMzMWawozApEurBjih0xcfDnlhGCHUMKPyk37k5xYbMZv4YRjwIjMEDQ6EzTMzONnU6eAtlwkzMC5sQhjKRTQ3azMji2ErwKbijCvD1nTDiZcdGEJ9n17787pcnP6sfP+/8Ahz6N/UQnP/P1ev2Z9hhRMhM+HsMHh691Uy9M1zx0xn13MeHPNFc5v8/rSOOmLkz9n1704g7YOkXNL+Zh2sTsTyjTA2TYxot8pF2w70NDTdikaIlmEzCDGiMXESDo2QYDZrJhgUlmLGsTGd8wIGuGJRm2FjFwMTpTgyJbOabMdCyUMOALiMFOKMP1vaU9pZhDYjc6nBY68qxiTOzSTNOhGYjBuFGcrQQjdIWbjcc0UBmJZzTdYFxubBighAhrgjEisBgFs05i2CYoxMYKIU6c+nhZpuaJGEWP/JPtjSWHrLBTsMWFGpoXdkuQs6NyGrGnYLENghRHUsUXKaSmy0efFmw2Aw8DRORcwMO0bNn/AJnWjYscmwR2KaIUcGEbBdxMrGxTTGzHNyytMxZUCPFzGLGzs0kQp1WNdNMrYxcMlJFTZxAJnK02SOSZWiNnRbFZusC72n972njZm7se8U6mhC5yAep8RBGELuhq2bF3gxhHgMIINDCmzG6aFlsuhqCPB4Orwf6jtZvScXAZrLwYYhjEzDXDBrp03NQw4hmMabDGwTFOWzEu5pxTgWgFuTP1zAFKUhPX6/W0LDOOgpPU884dd8xmMTw+mYoHnnm4rOZuc7vTDWQo1xPD2Y6UJG64zPUlDDPgNvqMBrudCyZ16PqMzKzHEYFz9JxIth6s2XsI2dim5GGhRWKOLYYxoKcMY2GhaYxoCLCs0xuRFGs7zN2ZhmyTOLjEyxvhKJnGSAwbGWYMlgY0xY4cNmEbNb9DgFMR1MxpgpwGn9L3IEIcWZZgXHAMQwxxwMGTGI1h1cRi3AsRMjoRhMLpibuIxUy5xQRhTiY6YjAg5hZ6b5mIiYRtlpKcBujgsURzzmaUmdMV0xu4uBEcc6MDN4aYxiuhChhCGGGQuZaRWLwQrIzP/EhCPFaEeWIRKyKaFiDc1bNh4c6bEG4dA6UIkTTdsKTOGwdDoBB6bxsEcRg53UaRjQTfI4zMRmHR3io3IQrNFh0WDFyWSMEjW5YLBSYxixM4pgtDs5sQYftD4mKxYRdDRpSOq0WNTQ1bsYwCFzrI5thNHVoCEYBYKzdbkIUsLN2lpjQOhAjdosalNmFguqTLCPJoGEeT+x8R3JdHrTyNijzPlfE7I3E+06MS7yMZLvFG51ZLGg3M006GjYdjUIXP/BCD1udA4FjVdnRh01LswTG2YFsoxsEYRYFNjKlIQwXxMxjRFyDTMaZYlEY0WIFyOHgurwAgXLlBhjZsLY3emqzctk1wRmaCMNUF0XvcXkakbpwabEIbDqjCixC5DQ4lNgGzGnVabAlF33hDRstmi5YjqQ1E0IcXV2GFyPAdD+xx09kOoz9f2HTOE2MfT9nq+f1c0zs+H0/x+j1v7/r9Xrbk5uPZ9HT7P9MhGwP0O/q+f5/475rnfph3nz/4/wCX2GHDpnp9H1/4T/LEAxlgbx3/APn/AN//AH0+GSATfOd+k3/x/wBN6TLWZ0Mj/h/n9WMmIVh3iv8ADcyzpGIljw8KyWIgIuEIQI0TeEFZj1sEMRpgY6BQYzgm9J0bl8zNZjHVWinL+XPc+uZZjMNn2ezDv0559Rvqb+ueG+V6T1b3xvj17+GOlc/qzzxY+iOPVzzzzMeH1Zay4Of8cO/P2T6d8Yrd6fWfQzPP6vA5zMMY6b+zEc88ZYDfD9nM+qZ54RY4Z9fs5zp/nzmbCrN/pr2Y3mbsxMuSc6znGFSN/XMgGQCA0QImA0M0UxRuURoxi7lJlmZvCLsVznQ3PmQ7t3MOomTn9LHiiPr6UaqMSwmhMToOIQS4Mx4GawuwLWYkLNEN8hMRc3GJvh6I0RiURzR1t2F2hY2KWwRIX3Q2SilaInjzGFkYO2Y0RIaMKMUx7j8B2jHp2MHEQeJN3LnjiBExENCPPpRbObuY+zJBoWyR3wwwxxzshEy+FZiFmMSxjnnK00PQQXCaFGTA0WDAucPhkphcmMTGMMw5bZCjBFmI6GhgE0IViYLJFgWN3pCDRYyGczFHJhF/M5wdq3XZJ0mL41N0hAmSZvvvvmFKD0afp51jwhTvgCL9P08941uTHONHh9G9Mx6iHToUdOfr9bCj1Y6Ytl6er7Mwz9XzzpjCUOc0LjpjJhpmMtdM53jCxDOCGN/A3yqhRkXOJ4EyU3KyEViZLOGYcUUFEB9TG66Yd+hN+eNFd+ZmP6R8TM0cM5KAsaOHRGmxRhHLCJThxGLPA6QGOI7xmIQiFZwZIMZnd3v09XhjOmbF9/DfwL5MzDbMZjNEzzAjjCRjOiuGAhZJu9MZwK6PTOd7JYpGOVjCEbEc+FxpKAfqwwxyM4IB02N4OFPmHuyvaQpmXYgrEOoWEadFIKxNQTpnVbsx06UxsNsNYs2GNiMKMQil8mYRczBGzhcxAmQsUhGhHexGFOc5jMjxKQQrNOmHg2Lls6IwhFRu2cYSl4rY/QXepBU4CXerpmyQRbMbkLG2I6MdnBwdDCDCzfJEg0xrNMzGzneYbmcZgwjjOMmhpnpk1LsIYz0Ml2xdxqUWLYhYo13xMmpbGd+m5MbNY3J0icGMT+h+IYEOTSYTZmekcuWOuY5jN8cFmY5BsQooznNZhkCzMWytJdykJ0ssIU0sIo0QzdxTm5WTN8t2N2hLj1NMBLpRwNMQoKKNSGhjktIwOLTT+A7lw9bGCnJrMYmxXTR6O2MQjhwTOdEjlYNLZt0yWYTLdZjM5kM5xYYTEYtEGkjYiplhGii7s0uCgZjRi40dSzlItJo8nVpINDwYzDlOLEzT1MYB+g8b3HRh4lscWZMBHQhDLk0dUMBwdXU4hGIt3ROL1EDjg2eLqUUxjsWNW5RTG5HxPF1LFHEjD9T2FB2OcwxyI5s5i7EcwBhqU5xGkOAMzZW7FjAGi4UhY1NBjwGgGlOK3InEuWdiimPENXxHcUsOpoe5j+cXscMYvFWLRsQGLbeOgTLY6OpWQi8SgGKjRYicBsWAUFI2LEYUuaEbEYkW4TLTjR2YWCY4IMSgdCCrbJoNNmELkzTFo2Vw2XuH9R2ox5MbJY6izjVglIo7lkiYEmTBkoabtZctF80ZnSAaAUTJgSmZLpChg0saYUWWZpbDunBpYCUaowWim5qicCkdSxcoTYjvMZ3xg5AJD9wdjClhxazfPLMWxDQtlpzCN3VyLC5TCnGeLo55Omae57CiEOTTqdxowsRjGPjGDwe0O5acQ/dk7XJZKNSmNNOrEuNixoQsrZCzQ1gsNmiFZdTUpLuqQsbNmmOjRwC7Yjd1dhjcue42OTE7nuXQ9IE5J3xKQ/Q3aP6k2C7T+R8zsfKx1PEP5WzR8h5SzofIxsMLsaPOfzMaH2k9CcE5PA+RLJxTZORonvmrR1jdho8R+E0ewj1PulmnVo0eweCPnGhPElFDCmzBsw+J7kjsWYfaPees0PcdiNjtOBdI0WHtLF3gcCxY5NmNjxkEbCWeL1lmEYXLD1jDk6PcaPcR60oYnvEWisOxB7Wk+IuWLtntG6XPElEbZsatI2YcSjUsmqcmm54xhyO05N3iw0NRhySJG7wLHWNjqYaDwIkYcsaI6mh5TsSNCnUQoiOiUR7U7CLBSOhq2OL1ugp1CwGFMKYaHiLMbNkhR1lKahY8bwINyNETsaNnZp4HFukeJ1ELNDZ8pHQY3YcB4EI0QSgYcTgaDYdE7V1SyRHZsU6JwIlFFjkENCijxGwwYKRGDR1FnRRunkM42GyMHQ2dWOjE5PBibDCsMwx6yyMOLoQ627YUos9i0LY+0bNETQ6kutNHUeQYXwtjtdWEYcDyIUkaGjJ2lk4ETYdWmJxaIg9jYulJRHsGJYjdCLiMF4Ny5CMLMYeMiRobEYMI7HFjsRKeRoaMFopIhs2aOtSyOrZs3SiyWIp5x2O02bARhR7ZYhxOBToJYaIwGGxsXHsdXU1KaWESMOp8Z3CUjCFyMIwianwtgjc0GxGYYe4bFxoY8EiRswsR6jyjdiQjRoUNECNki8SHmLNBGhpIl2iiKD6DktFBs2GNMOojZ8bZbsLEYLdojBYdrdHxMYRo0SmFLZI+Y7HV6nFmimYYPnLJqbOmGiMaI0RInjOs8jZIUsIwieg4EWkuXNSmYiD8DY4N2N2ksLB7jYsJ2lih0RjZxMwTsdTgalPFpul2JGk997ngNJo4Yecg8GPJ60glh910Nnix2LNOH3jVhZiXdER1E+NILq2EdG6WHV+BNSJGNDZ4tn5n0gMb/6MAAwH0gXI/8H9j+te+PfM/gO+Xf0B2P3zgcHsP9R1ne6r4n/a7NPtH7X5V4PEufGdq9yvzPWeQ+Y8x5zqOT+E7nrftPoLGh9w/IHE9t1bPlfKfGcH3Cz+w1eJxPG+68HxP5jiHkdDY/E/CQ8Rqf3nwHJf5n7p5A944mrc+2fdNX33/AHGj6DTFjR9t8r1sKbOp1HnPeOL/AN37hC71voPI3P1rD8i+Nh952I9r+V2VY6Gx7T7ZxbHF/M8T+tu0WGjU9w7CnrdXgw+J7HZbKQ/IsYHU8Tqeohse4WGkp958TwYGpRGnzFB5GPaFBGn4nqLtnke8+g4Op7xqeNXVpbBT+NisbPAsur3Gq+VisWxq/iAhotn3w98sR+AuegjZstntbnY+V2YfhfOBCHlfKeYoh1tPuvmLj2HkPuFmF3+wstin9Ld9JBFnpA3Z78M9ICKnfIH9r+Q8z1Pe9n856H/q97+f9HvcX/y+kBB30gN2fAH/AKP9i+kBHl/tP3PfPvpAXl9I6jB+tp/O7P5WNKtP9YWaVp0PwHU3KV/ElkutFMW5ofKNLYwA0Q0Y/MwY8V0CNHyt25otF3R+E2ULsYBDtfvEWzYQ0SK/IXLMBbkODGEblj7bRGzAuGoN2575xaNSYOJ1HwtmzY1eo+Q1IvAAOB8pdgcGNjU1T2mzd4OoFMaDU9DRYI7NFNwNjQ4HkGjUbDRGNN0hqJTT5xOsNGLZ0KWNmz53k0wbLowGmLwLHxtFiECME5HunUWxZV7nR+MsXCz3OiWLHjOpo7j+Q0LHB6y7ydDzFHJ0eRq/deos3Cgo+B7FjZpWF2BHxJoe2XaLrFjosHyvcXeBTAKIAFNPE90h4miEfGfKw2bGgcG59tjRYuEW5q0+I85qbPFOByO08gWPzPadrqanF90IeM/pX235HqP1PUUeh9wpsR4lyjQ8r7TF8x4zgdqWLGidR5y54mEDzn3nyNP+tYgUcXznwP4X3F9p2P5R+0UfnPwp+N7249o+48ji6H9x2HjO+Vf5XrfOfCf0Ptn9Lxf+z6D43Vu+0fEe6/pPM/jbr3D9995++na/jPdP5yin9r6QYvPSAlh3xj3vo/3Hf4n+8+899498MXO/RPunYe097ue6d849z/cd8AekBVHvrDY9ICuP973wr6QOhes9IDOHpM5H/6E=\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/afis/match"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Sun, 26 Apr 2020 21:04:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"personToPersonMatchResponse\": [\n {\n \"basicResponse\": [\n {\n \"id\": [\n \"UUID\"\n ],\n \"error\": [\n {\n \"code\": [\n \"SUCCESS\"\n ],\n \"message\": [\n \"NO_HIT\"\n ]\n }\n ],\n \"duration\": [\n \"360\"\n ]\n }\n ]\n }\n ]\n}"},{"id":"91e8d48f-518e-4b63-88ae-1734709d8469","name":"200 - Broken Fingerprint","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"rightThumb\": \"Broken Fingerprint\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/afis/match"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Sun, 26 Apr 2020 21:03:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Error en la consulta\"\n}"},{"id":"bc53dbf2-4e5a-4aaf-90a4-ab112a772bb9","name":"02 - Match person","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"rightThumb\": \"Base64 Fingerprint\"\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/afis/match"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:7e8b5d1f-7db2-4ada-9727-bc278f906e1b"},{"key":"Date","value":"Sun, 26 Apr 2020 21:02:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"personToPersonMatchResponse\": [\n {\n \"basicResponse\": [\n {\n \"id\": [\n \"UUID\"\n ],\n \"error\": [\n {\n \"code\": [\n \"SUCCESS\"\n ]\n }\n ],\n \"duration\": [\n \"186\"\n ]\n }\n ],\n \"candidate\": [\n {\n \"id\": [\n \"IDENTIFIER\"\n ],\n \"score\": [\n \"15051\"\n ],\n \"decision\": [\n \"HIT\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"367f5dd6-ed73-493a-bfc1-9124326ccfcf"}],"id":"2cf2687d-568f-4d0e-9c03-198c55de89c8","_postman_id":"2cf2687d-568f-4d0e-9c03-198c55de89c8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","id":"8d347853-49e6-4ca9-aeb2-78154ce9ebd9","name":"VeriDocID API Docs old","type":"collection"}}},{"name":"Credit","item":[{"name":"rccficoscore","event":[{"listen":"test","script":{"id":"6c61abec-67de-49c7-a175-3eb25d15876e","exec":["const req = JSON.parse(request.data);","let resp = {};","","try {"," resp = pm.response.json();","}","catch (e) {}","","pm.test(`Status code should be ${pm.response.code}`, function () {"," if (pm.response.code === 400) {"," pm.response.to.have.status(400);",""," if(!resp.error.errores) {"," pm.test(`Error should be ${resp.error}`, function () {"," pm.expect(resp.error).to.eql('id field is missing');"," });"," } else {"," pm.test('Error should has an array of errores', function () {"," pm.expect(resp.error.errores[0].codigo).to.be.oneOf(['400.1', '400.2']);"," });"," }"," } else if (!(_.get(request.headers, 'authorization')) || pm.response.code === 401) {"," pm.response.to.have.status(401);",""," pm.test(\"Message should be Unauthorized\", function () {"," pm.expect(resp.message).to.eql('Unauthorized. Access token is missing or invalid.');"," });"," } else if(pm.response.code === 403) {"," pm.response.to.have.status(403);",""," pm.test(`Error should be ${resp.error}`, function () {"," pm.expect(resp.error).to.eql(resp.error);"," });"," }else {"," pm.response.to.have.status(200);",""," pm.test(\"Respsonse should contains folioConsulta\", function() {"," pm.response.to.have.jsonBody(\"folioConsulta\");"," pm.collectionVariables.set(\"folioConsulta\", resp.folioConsulta);"," });",""," pm.test(\"Respsonse should contains folioConsultaOtorgante\", function() {"," pm.response.to.have.jsonBody(\"folioConsultaOtorgante\");"," });",""," pm.test(\"Respsonse should contains claveOtorgante\", function() {"," pm.response.to.have.jsonBody(\"claveOtorgante\");"," });",""," pm.test(\"Respsonse should contains declaracionesConsumidor\", function() {"," pm.response.to.have.jsonBody(\"declaracionesConsumidor\");"," });",""," pm.test(\"Respsonse should contains persona\", function() {"," pm.response.to.have.jsonBody(\"persona\");"," });",""," pm.test(\"Respsonse should contains consultas\", function() {"," pm.response.to.have.jsonBody(\"consultas\");"," });",""," pm.test(\"Respsonse should contains creditos\", function() {"," pm.response.to.have.jsonBody(\"creditos\");"," });",""," pm.test(\"Respsonse should contains domicilios\", function() {"," pm.response.to.have.jsonBody(\"domicilios\");"," });",""," pm.test(\"Respsonse should contains empleos\", function() {"," pm.response.to.have.jsonBody(\"empleos\");"," });",""," pm.test(\"Respsonse should contains scores\", function() {"," pm.response.to.have.jsonBody(\"scores\");"," });",""," pm.test(\"Respsonse should contains mensajes\", function() {"," pm.response.to.have.jsonBody(\"mensajes\");"," });"," }","});"],"type":"text/javascript"}}],"id":"866c496f-6ea5-4912-82e0-24525574f906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"alphanumeric\",\n \"apellidoPaterno\": \"SESENTAYDOS\",\n \"apellidoMaterno\": \"PRUEBA\",\n \"primerNombre\": \"JUAN\",\n \"fechaNacimiento\": \"1965-08-09\",\n \"RFC\": \"SEPJ600800LZ1\",\n \"nacionalidad\": \"MX\",\n \"domicilio\": {\n \"direccion\": \"PASADISO ENCONTRADO 58\",\n \"coloniaPoblacion\": \"MONTEVIDEO\",\n \"delegacionMunicipio\": \"GUSTAVO A MADERO\",\n \"ciudad\": \"CIUDAD DE MÉXICO\",\n \"estado\": \"CDMX\",\n \"CP\": \"07730\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://veridocid.azure-api.net/api/credit/rccficoscore","description":"Credit Report
\nHTTPS POST method to obtain the credit report. You will receive a full credit report.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| id* | \nint | \n10 | \n
\n\n| apellidoPaterno* | \nstring | \nSAHAGUN | \n
\n\n| apellidoMaterno* | \nstring | \nZARAGOZA | \n
\n\n| apellidoAdicional | \nstring | \nTORRES | \n
\n\n| primerNombre* | \nstring | \nROBERTO | \n
\n\n| segundoNombre | \nstring | \nMIGUEL | \n
\n\n| fechaNacimiento* | \nstring ($yyyy-MM-dd) | \n2001-01-01 | \n
\n\n| RFC* | \nstring | \nSAZR010101 | \n
\n\n| CURP | \nstring | \nSAZR010101HCMLNS09 | \n
\n\n| nacionalidad* | \nCatalogoNacionalidad string | \nMX | \n
\n\n| residencia | \nCatalogoResidencia integer | \n3 | \n
\n\n| estadoCivil | \nCatalogoEstadoCivil string | \nS | \n
\n\n| sexo | \nCatalogoSexo string | \nF | \n
\n\n| claveElectorIFE | \nstring | \n000000000000 | \n
\n\n| numeroDependientes | \ninteger ($int32) | \n4 | \n
\n\n| fechaDefuncion | \nstring ($yyyy-MM-dd) | \n9999-01-01 | \n
\n\n| domicilio* | \nobject | \n{ objectDomicilio } | \n
\n\n
\n
objectDomicilio
\nDatos del domicilio de la persona a consultar
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| dirección* | \nint | \nHIDALGO 32 | \n
\n\n| coloniaPoblacion* | \nstring | \nCENTRO | \n
\n\n| delegacionMunicipio* | \nstring | \nLA BARCA | \n
\n\n| ciudad* | \nstring | \nBENITO JUAREZ | \n
\n\n| estado* | \nCatalogoEstados string | \nJAL | \n
\n\n| CP* | \nstring | \n47917 | \n
\n\n| fechaResidencia | \nstring ($yyyy-MM-dd) | \n2018-12-21 | \n
\n\n| numeroTelefono | \nstring | \n5512345678 | \n
\n\n| tipoDomicilio | \nCatalogoTipoDomicilio string | \nC | \n
\n\n| tipoAsentamiento | \nCatalogoTipoAsentamiento integer | \n3 | \n
\n\n
\n
CatalogoNacionalidad
\nDescripciones para los valores enviados en este campo
\n\n\n\n| Clave | \nPaís | \n
\n\n\n\n| AD | \nAndorra | \n
\n\n| AF | \nAfganistán | \n
\n\n| AG | \nAntigua y Barbado | \n
\n\n| AI | \nAnguila | \n
\n\n| AN | \nAlbania | \n
\n\n| AO | \nAngola | \n
\n\n| AS | \nAscención | \n
\n\n| AT | \nArgentina | \n
\n\n| AU | \nAustralia | \n
\n\n| AW | \nArabía | \n
\n\n| BB | \nBarbados | \n
\n\n| BD | \nBangladesh | \n
\n\n| BE | \nBélgica | \n
\n\n| BF | \nBurkina | \n
\n\n| BG | \nBulgaria | \n
\n\n| BH | \nBahrein | \n
\n\n| BI | \nBurundi | \n
\n\n| BJ | \nBenin | \n
\n\n| BK | \nBirmania | \n
\n\n| BM | \nBután | \n
\n\n| CB | \nColombia | \n
\n\n| CC | \nCórcega | \n
\n\n| CD | \nChad | \n
\n\n| CF | \nRep. Central Africana | \n
\n\n| CG | \nCongo | \n
\n\n| CH | \nLiechtenstein | \n
\n\n| CI | \nIslas Caimán | \n
\n\n| CJ | \nComoros | \n
\n\n| CL | \nChile | \n
\n\n| CM | \nCamerún | \n
\n\n| MX | \nMéxico | \n
\n\n
\n
CatalogoResidencia
\nDescripciones para los valores enviados en este campo
\n\n\n\n| Clave | \nDescripción | \n
\n\n\n\n| 1 | \nPropietario | \n
\n\n| 2 | \nRenta | \n
\n\n| 3 | \nVive con familiares | \n
\n\n| 4 | \nVivienda Hipotecada | \n
\n\n| 5 | \nNo Disponible | \n
\n\n
\n
CatalogoEstadoCivil
\nDescripciones para los valores enviados en este campo
\n\n\n\n| Clave | \nDescripción | \n
\n\n\n\n| D | \nDivorciado | \n
\n\n| L | \nUnión Libre | \n
\n\n| C | \nCasado | \n
\n\n| S | \nSoltero | \n
\n\n| V | \nViudo | \n
\n\n| E | \nSeparado | \n
\n\n
\n
CatalogoSexo
\nDescripciones para los valores enviados en este campo
\n\n\n\n| Clave | \nDescripción | \n
\n\n\n\n| F | \nFemenino | \n
\n\n| M | \nMasculino | \n
\n\n
\n
CatalogoTipoDomicilio
\nDescripciones para los valores enviados en este campo
\n\n\n\n| Clave | \nDescripción | \n
\n\n\n\n| N | \nNegocio | \n
\n\n| O | \nDomicilio del otorgante | \n
\n\n| C | \nCasa | \n
\n\n| P | \nApartado Postal | \n
\n\n| E | \nEmpleo | \n
\n\n
\n
CatalogoTipoAsentamiento
\nDescripciones para los valores enviados en este campo
\n\n\n\n| Clave | \nPaís | \n
\n\n\n\n| 0 | \nPendiente por actualizar | \n
\n\n| 1 | \nAeropuerto | \n
\n\n| 2 | \nBarrio | \n
\n\n| 3 | \nBase Naval | \n
\n\n| 4 | \nCampamento | \n
\n\n| 5 | \nCentro | \n
\n\n| 6 | \nCentro Urbano | \n
\n\n| 7 | \nColonia | \n
\n\n| 8 | \nCondominio | \n
\n\n| 9 | \nCongregacion | \n
\n\n| 10 | \nConjunto Habitacional | \n
\n\n| 11 | \nConjunto Habitacional Residencial | \n
\n\n| 12 | \nConjunto Habitacional Urbano | \n
\n\n| 13 | \nConjunto Popular | \n
\n\n| 14 | \nConjunto Residencial | \n
\n\n| 15 | \nConjunto Urbano | \n
\n\n| 16 | \nConjunto Urbano Popular | \n
\n\n| 17 | \nEjido | \n
\n\n| 18 | \nEscuela | \n
\n\n| 19 | \nEstación de Radio | \n
\n\n| 20 | \nEx-Hacienda | \n
\n\n| 21 | \nEx-Rancho | \n
\n\n| 22 | \nFábrica | \n
\n\n| 23 | \nFinca | \n
\n\n| 24 | \nFraccionamiento | \n
\n\n| 25 | \nFraccionamiento Industrial | \n
\n\n| 26 | \nFraccionamiento Residencial | \n
\n\n| 27 | \nGranja | \n
\n\n| 28 | \nHacienda | \n
\n\n| 29 | \nIngenio | \n
\n\n| 30 | \nJunta Auxilia | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nFull report resource | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
To obtain the results of /creditos endpoint, replace the path param {folioConsulta} with your own folio that you got in /rccficoscore endpoint
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON object | \nResource | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
To obtain the results of /domicilios endpoint, replace the path param {folioConsulta} with your own folio that you got in /rccficoscore endpoint
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON object | \nResource | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
To obtain the results of /empleos endpoint, replace the path param {folioConsulta} with your own folio that you got in /rccficoscore endpoint
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON object | \nResource | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
To obtain the results of /consultas endpoint, replace the path param {folioConsulta} with your own folio that you got in /rccficoscore endpoint
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON object | \nResource | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
To obtain the results of /scores endpoint, replace the path param {folioConsulta} with your own folio that you got in /rccficoscore endpoint
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON object | \nResource | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
To obtain the results of /mensajes endpoint, replace the path param {folioConsulta} with your own folio that you got in /rccficoscore endpoint
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON object | \nResource | \n
\n\n| 401 | \nJSON ErrorMessage object | \nUnauthorized | \n
\n\n| 404 | \nJSON ErrorMessage object | \nResource Not Found | \n
\n\n
\n
Create sign webhook
\nHTTPS POST method that creates a webhook.\n
\n
\nThe field url is required, this url should be the endpoint where you want to receive responses.\n
\nThe field type is optional, this specifies which kind of documents you will receive.\n
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| url* | \nstring | \nurl customize | \n
\n\n| type | \nStatusDocumentType | \ncompletedDocument | \n
\n\n
\n
StatusDocumentType
\n\n\n\n| Key | \nType | \n
\n\n\n\n| completedDocument | \nImage | \n
\n\n| signDocument | \nImage | \n
\n\n| sendDocument | \nImage | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Update sign webhook
\nHTTPS PUT method that updates a sign webhook.\n
\n
\nThe field url should be the same that you use on method POST Add Webhook.\n
\nThe filed webHookID should be the webHookID that you receive on method POST Add Webhook.\n
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| url* | \nstring | \nurl customize | \n
\n\n| webHookID* | \nstring | \n7c0e7ab01651db416e4 | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Get sign webhooks
\nHTTPS GET method that gives you information about the webhook you requested.\n
\n
\nThe param webhookID should be the same webHookID that you obtained on method POST Add Webhook.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Delete sign webhook
\nHTTPS DELETE method that deletes a webhook.\n
\n
\nThe param webHookID should be the same webHookID that you obtained on method POST Add Webhook.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS POST method to add a new document to be signed.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| document* | \nfile | \nsample.pdf | \n
\n\n| documentSignType | \nstring ['ELECTRONIC_SIGNATURE', 'E_FIRMA'] | \nELECTRONIC_SIGNATURE | \n
\n\n| country | \nstring ['Mexico', 'United States', 'Canada', 'New Zealand', 'Australia', 'Afghanistan', 'Aland Islands','Albania'] | \nMexico | \n
\n\n| language | \nstring ['es', 'en'] | \nes | \n
\n\n| position | \nstring | \ngeolocation | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS PUT method to update some info to a document to be signed.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| documentID* | \nstring | \n5faef0fdf15d4400321a | \n
\n\n| documentSignType | \nstring ['ELECTRONIC_SIGNATURE', ' E_FIRMA'] | \nELECTRONIC_SIGNATURE | \n
\n\n| country | \nstring | \nMexico | \n
\n\n| position | \nstring | \ngeolocation | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS DELETE method to delete a document to be signed.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| documentID* | \nstring | \n5faef0fdf15d4400321a | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS GET method to get a document to be signed.
\nparams
\n\n\n\n| params | \nExample | \n
\n\n\n\n| documentID* | \n5faef0fdf15d4400321a | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information. Available values for 'status' : ALL, DRAFT, PENDING, COMPLETED | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS GET method to get a document to be signed.
\nparams
\n\n\n\n| params | \nExample | \n
\n\n\n\n| status | \nALL, DRAFT, PENDING or COMPLETED | \n
\n\n| limit | \n0 | \n
\n\n| skip | \n0 | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information. Available values for 'status' : ALL, DRAFT, PENDING, COMPLETED | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS PUT method to resend a document to be signed.
\nparams
\n\n\n\n| params | \nExample | \n
\n\n\n\n| documentID* | \n5faef0fdf15d4400321a | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS PUT method to share the document already signed.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| documentID* | \nstring | \n5faef0fdf15d4400321a | \n
\n\n| postedTo | \nstring | \nsomeone@mail.com | \n
\n\n| country | \nstring | \nMexico | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS PUT method to assign a space to sign in the document.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| documentID* | \nstring | \n5faef0fdf15d4400321a | \n
\n\n| staticSignPositions | \narr[obj] | \n[obj] | \n
\n\n
\n
\n- Obj Example *
\n {\n\"imageSize\": {\n \"width\": \"10\",\n \"height\": \"10\"\n},\n\"parentImageSize\": {\n \"width\": \"20\",\n \"height\": \"20\"\n},\n\"viewport\": {\n \"width\": \"20\",\n \"height\": \"20\"\n},\n\"user\": {\n \"email\": \"someone@mail.com\"\n},\n\"coordinates\": {\n \"x\": \"1\",\n \"y\": \"1\"\n},\n\"page\": 1,\n\"color\": \"#880022 \",\n\"pageY\": 648,\n\"pageYv2\": 648\n } \n
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS PUT method to send the document to sign to the signers.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| documentID* | \nstring | \n5faef0fdf15d4400321a | \n
\n\n| message | \nstring | \nmensaje | \n
\n\n| title | \nstring | \ntitulo | \n
\n\n| disableMailing | \nboolean | \nfalse | \n
\n\n| signatory | \narray | \n[ {SignerObject*}, {}... ] | \n
\n\n| sharedWith | \narray | \n[ {sharedWithObject*}, {}... ] | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Sign document
\nHTTPS POST method to validate if a document is already signed correctly.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| document* | \nfile | \nsample.pdf | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Create webhook
\nHTTPS POST method that creates a webhook.\n
\n
\nThe field name is required, this name allows you to identify your webhook, you can name it as you want.\n
\nThe field url is also required, this url should be the endpoint where you want to receive responses.\n
\nThe field type specifies which type do you want to receive id or ocr.\n
\nThe field publicKey is optional, this is a rsa public key 2048 bits that helps you to encrypted the json.\n
\n
\nNOTE: The cipher method is only allowed with type id.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| name* | \nstring | \nfirst webhook | \n
\n\n| url* | \nstring | \nurl customize | \n
\n\n| type* | \nstring can be id or ocr | \nocr | \n
\n\n| publicKey | \nstring base64 | \npublicKey rsa 2048 bits, format pem encoded in base64 | \n
\n\n
\n
-----BEGIN PUBLIC KEY-----\nMIIBITANBgkqhkiG9w0BAQEFAAOCAQ4AMIIBCQKCAQBlN3YjtwEE0lIUBmVbdPHJ\nPbc5zOBxMOh7FSwF4sBMDq7VbdEPBRp+FGOVMkkIeRDLRQBJDtso9ILv7tiY4WP6\ntGtIErrBBiaTpcWOq9LHbuhA01JE3L31ri/QpWLU/Oz8JfC3MjsdPvLYbfhRwYvb\nyrTohaTpOhpKKbs9c2E+X1tc0xZkP/Eu0cPr31xnurGvOhz/k6fhU2SoLGnDp2FL\njLr0uOnNgwvhbIdt9zuDZ2Lj4BvzCH87kCDpb7g2dnLtRMIzgO/HCdNWZ+0ivfpe\nV2f/AgQyDtcKBMVPqnxzKlDQLAQ/TLzNBHOO3LWtll28QGxcTyJZFDRQWyQBgHgd\nAgMBAAE=\n-----END PUBLIC KEY-----
\nHow do you have to decipher the data
\nYou will receive the cipher data, the key comes into the first 256 bytes, the iv comes since 256 bytes to 512 bytes and finally the data starts at 512 bytes to the end.\nTo decipher you have to use RSA method using sha256 as a oapesh, RSA_PKCS1_OAEP_PADDING as a padding and the public key that you create as a key.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Update webhook
\nHTTPS PATCH method that updates a webhook.\n
\n
\nThe fields url and name should be the same that you use on method POST Add Webhook.\n
\nThe filed type should be different tha you used before.\n
\nThe field id should be the same id that you obtained on method POST Add Webhook.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| name* | \nstring | \nfirst webhook | \n
\n\n| url* | \nstring | \nurl customize | \n
\n\n| type* | \nstring can be id or ocr | \nid | \n
\n\n| id* | \nstring | \nid obtained on add webhook | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Delete webhook
\nHTTPS DELETE method that deletes a webhook.\n
\n
\nThe field id should be the same id that you obtained on method POST Add Webhook.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| id* | \nstring | \nid obtained on add webhook | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Get webhooks
\nHTTPS GET method that gives you an array of all your webhooks you have been created.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Get webhooks
\nHTTPS GET method that gives you an object of all your webhooks you have been created.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Create webhook
\nHTTPS POST method that creates a webhook.
\nThe field name is required, this field allows you to identify your webhook, you can name it as you want.
\nThe field url is also required, this url should be the endpoint where you want to receive responses.
\nThe field type is also required, these field specify the type of notification you want to receive. Only the criminal-record type is allowed.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| name* | \nstring | \nwebhook_test | \n
\n\n| type* | \nstring | \ncriminal-record | \n
\n\n| url* | \nstring | \nurl customize | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Update webhooks
\nHTTPS PATCH method that update a webhook.
\nThe field webhook_id is required, this webhook_id must be the same as the previous one.
\nThe field type is also required, this type must be the same as the previous one. Only the criminal-record type is allowed.
\nThe field name is also required, this url should be the same or different from the previous one.
\nThe field url is also required, this url should be the same or different from the previous one.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| webhook_id* | \nstring | \nwebhook_id obtained on add webhook or get webhooks | \n
\n\n| type* | \nstring | \ncriminal-record | \n
\n\n| name* | \nstring | \nwebhook_name | \n
\n\n| url* | \nstring | \nurl customize | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Delete webhook
\nHTTPS DELETE method that deletes a webhook.
\nThe field webhook_id should be the same id that you obtained on method POST Add Webhook.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| webhook_id* | \nstring | \nwebhook_id obtained on add webhook or get webhook | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Check Criminal Records
\nHTTPS POST method to create a new check of criminal records. You will receive three important fields: check_id, scores and status.\n
\n
\nThe field id is required, this field allows you to identify your check, you can name it as you want.\n
\nThe field national_id is also required, you will type the curp of the person you want to check.\n
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| id* | \nstring | \ntest01 | \n
\n\n| national_id* | \nstring | \ncurp | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Get Details
\nHTTPS POST method to obtain details of criminal records\n
\n
\nThe field check_id is also required, you can get it when you check the criminal record history\n
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| check_id* | \nstring | \n | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n | \n | \n | \n
\n\n
\n
Process Person
\nHTTPS POST method that receives a json with information about the person was looking for, if there is information in the data base.\n
\n
\nThe requestType is required, this specifies what kind of request it is.\n
\nThe typeSelectedRequest is required, this is an object that contains types of the selected request. Shall be the same type as you indicated on requestType.\n
\nrequestType
\n\n\n\n| Key | \nType | \n
\n\n\n\n| INSERT_PERSON | \nstring | \n
\n\n| UPDATE_PERSON | \nstring | \n
\n\n| DELETE_PERSON | \nstring | \n
\n\n| GET_PERSON | \nstring | \n
\n\n| EXIST_PERSON | \nstring | \n
\n\n| MATCH_PERSON_TO_PERSON | \nstring | \n
\n\n
\n
typeSelectedRequest
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| insertPersonRequest | \nstring | \nUse this one if your requestType is INSERT_PERSON | \n
\n\n| updatePersonRequest | \nstring | \nUse this one if your requestType is UPDATE_PERSON | \n
\n\n| deletePersonRequest | \nstring | \nUse this one if your requestType is DELETE_PERSON | \n
\n\n| getPersonRequest | \nstring | \nUse this one if your requestType is GET_PERSON | \n
\n\n| existPersonRequest | \nstring | \nUse this one if your requestType is EXIST_PERSON | \n
\n\n| personToPersonMatchRequest | \nstring | \nUse this one if your requestType is MATCH_PERSON_TO_PERSON | \n
\n\n
\n
Object tenprint
\n\n\n\n| Key | \nType | \n
\n\n\n\n| rightThumb | \nImage | \n
\n\n| rightIndex | \nImage | \n
\n\n| rightMiddle | \nImage | \n
\n\n| rightRing | \nImage | \n
\n\n| rightLittle | \nImage | \n
\n\n| leftThumb | \nImage | \n
\n\n| leftIndex | \nImage | \n
\n\n| leftMiddle | \nImage | \n
\n\n| leftRing | \nImage | \n
\n\n| leftLittle | \nImage | \n
\n\n
\n
Object slap442
\n\n\n\n| Key | \nType | \n
\n\n\n\n| rightHand | \nImage | \n
\n\n| leftHand | \nImage | \n
\n\n| thumbs | \nImage | \n
\n\n| MissingFingers | \nImage | \n
\n\n
\n
Object slap4411
\n\n\n\n| Key | \nType | \n
\n\n\n\n| rightHand | \nImage | \n
\n\n| leftHand | \nImage | \n
\n\n| rightThumb | \nImage | \n
\n\n| leftThumb | \nImage | \n
\n\n| MissingFingers | \nImage | \n
\n\n
\n
Image
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| format | \nstring | \nImageFormatType | \n
\n\n| buffer | \nstring | \nImage in base64Binary | \n
\n\n
\n
\n\n\n| Values | \n
\n\n\n\n| Accepts the following format types of image: | \n
\n\nRAW, BPM, WSQ,
JPEG, JP2, TIFF,
PNG, GIF, UNSPECIFIED, NOT_RAW,
ISO_19794_4, ISO_19794_5, ISO_19794_6 | \n
\n\n
\n
MissingFingers
\n\n\n\n| Key | \nType | \nDescription | \n
\n\n\n\n| rightThumb | \nboolean | \nSet true if the finger is missing | \n
\n\n| rightIndex | \nboolean | \nSet true if the finger is missing | \n
\n\n| rightMiddle | \nboolean | \nSet true if the finger is missing | \n
\n\n| rightRing | \nboolean | \nSet true if the finger is missing | \n
\n\n| rightLitte | \nboolean | \nSet true if the finger is missing | \n
\n\n| leftThumb | \nboolean | \nSet true if the finger is missing | \n
\n\n| leftIndex | \nboolean | \nSet true if the finger is missing | \n
\n\n| leftMiddle | \nboolean | \nSet true if the finger is missing | \n
\n\n| leftRing | \nboolean | \nSet true if the finger is missing | \n
\n\n| leftLitte | \nboolean | \nSet true if the finger is missing | \n
\n\n
\n
Request Body Model MatchPersonToPerson
\n
\nNOTE: sampleType could be TENPRINT_SLAP, SLAP_442 or SLAP_441.\n
\n\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| requestType* | \nstring | \nMATCH_PERSON_TO_PERSON | \n
\n\n| personToPersonMatchRequest* | \nobject | \n{
person: {
registration: {
fingerprintSample: {
sampleType: \"TENPRINT_SLAP\",
tenprint: {
}
}
}
}
} | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with the address normalized | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid license | \n
\n\n
\n
Validate email address
\nHTTPS POST method that creates a new validation of an email address.
\n
\nThe field id is required, this id allows you to identify your validation, you can name it as you want.\n
\nThe field email is also required, you have to send a valid email address.\n
\n
\nYou will recive a Json response which contains the following fields:\n
\nsuccess: this is a field boolean. If the email validation was correctly done, you will receive true.\n
\nerror: if success is true, you will receive an empty object. In the other case, you will receive an object with error specifications.\n
\ndata: if success is false, you will receive an empty object. In the other case, you will receive an object with information that will helps you to determinate if the email address is correct.
\nRequest Parameters
\n\n\n\n| Property | \nExample | \nType | \n
\n\n\n\n| id* | \ntest | \nstring | \n
\n\n| email* | \nexample@outlook.com | \nstring | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with informative data | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid license | \n
\n\n
\n
Validate phone number
\nHTTPS POST method that creates a new validation of a phone number.
\n
\nThe field id is required, this id allows you to identify your validation, you can name it as you want.\n
\nThe field phone is also required, you have to send a valid phone number with the area code.\n
\n
\nYou will recive a Json response which contains the following fields:\n
\nsuccess: this is a field boolean. If the phone number was correctly done, you will receive true.\n
\nerror: if success is true, you will receive an empty object. In the other case, you will receive an object with error specifications.\n
\ndata: if success is false, you will receive an empty object. In the other case, you will receive an object with information that will helps you to determinate if the email address is correct.
\nRequest Parameters
\n\n\n\n| Property | \nExample | \nType | \n
\n\n\n\n| id* | \ntest | \nstring | \n
\n\n| phone* | \n5255555555 | \nnumber | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with informative data | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid license | \n
\n\n
\n
Validate blaklist
\nHTTPS POST method that creates a new validation of blacklist.
\n
\nThe field id is required, this id allows you to identify your validation, you can name it as you want.\n
\nThe field name is also required, a name must be sent to improve the search in the blacklists.\n
\nThe field date_of_bith is optional, although it is recommended to send a valid date to improve the blacklist search.\nPossible variations are
\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).
\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).
\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).
\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).
\n
\nThe exact_match field is also required, a value between 1 and 2 must be sent to improve the blacklist search. \n
\n
\nYou will recive a Json response which contains the following fields:\n
\ntimestamp: this is a field for the time the search request was made. If the data entered are correct, you will receive the time.\n
\ntotal_hits: this is a field that displays the results found in the blacklists.\n
\nfound_records: if total_hits is zero, you will receive an empty object. In the other case, you will receive an object with information that will help you verify the risk associated with that person.
\nRequest Parameters
\n\n\n\n| Property | \nExample | \nType | \n
\n\n\n\n| id* | \ntest | \nstring | \n
\n\n| name* | \nBoris Johnson | \nstring | \n
\n\n| date_of_birth | \nDD/MM/YYYY | \nstring | \n
\n\n| exact_match* | \n2 | \ninteger | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with informative data | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid license | \n
\n\n
\n
Create sign webhook
\nHTTPS POST method that creates a webhook.\n
\n
\nThe field url is required, this url should be the endpoint where you want to receive responses.\n
\nThe field type is optional, this specifies which kind of documents you will receive.\n
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| url* | \nstring | \nurl customize | \n
\n\n| type | \nStatusDocumentType | \ncompletedDocument | \n
\n\n
\n
StatusDocumentType
\n\n\n\n| Key | \nType | \n
\n\n\n\n| completedDocument | \nImage | \n
\n\n| signDocument | \nImage | \n
\n\n| sendDocument | \nImage | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Create sign webhook
\nHTTPS POST method that creates a webhook.\n
\n
\nThe field url is required, this url should be the endpoint where you want to receive responses.\n
\nThe field type is optional, this specifies which kind of documents you will receive.\n
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| url* | \nstring | \nurl customize | \n
\n\n| type | \nStatusDocumentType | \ncompletedDocument | \n
\n\n
\n
StatusDocumentType
\n\n\n\n| Key | \nType | \n
\n\n\n\n| completedDocument | \nImage | \n
\n\n| signDocument | \nImage | \n
\n\n| sendDocument | \nImage | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Create webhook
\nHTTPS POST method that creates a webhook.
\nThe field name is required, this name allows you to identify your webhook, you can name it as you want.
\nThe field url is also required, this url should be the endpoint where you want to receive responses.
\nThe field type specifies which type do you want to receive id, ocr or sign.
\nThe field publicKey is optional, this is a rsa public key 2048 bits that helps you to encrypted the json.
\nNOTE: The cipher method is only allowed with type id.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| name* | \nstring | \nfirst webhook | \n
\n\n| url* | \nstring | \nurl customize | \n
\n\n| type* | \nstring can be id, ocr or sign. | \nsign | \n
\n\n| publicKey | \nstring base64 | \npublicKey rsa 2048 bits, format pem encoded in base64 | \n
\n\n
\n
-----BEGIN PUBLIC KEY-----
MIIBITANBgkqhkiG9w0BAQEFAAOCAQ4AMIIBCQKCAQBlN3YjtwEE0lIUBmVbdPHJ
Pbc5zOBxMOh7FSwF4sBMDq7VbdEPBRp+FGOVMkkIeRDLRQBJDtso9ILv7tiY4WP6
tGtIErrBBiaTpcWOq9LHbuhA01JE3L31ri/QpWLU/Oz8JfC3MjsdPvLYbfhRwYvb
yrTohaTpOhpKKbs9c2E+X1tc0xZkP/Eu0cPr31xnurGvOhz/k6fhU2SoLGnDp2FL
jLr0uOnNgwvhbIdt9zuDZ2Lj4BvzCH87kCDpb7g2dnLtRMIzgO/HCdNWZ+0ivfpe
V2f/AgQyDtcKBMVPqnxzKlDQLAQ/TLzNBHOO3LWtll28QGxcTyJZFDRQWyQBgHgd
AgMBAAE=
-----END PUBLIC KEY-----
\nHow do you have to decipher the data
\nYou will receive the cipher data, the key comes into the first 256 bytes, the iv comes since 256 bytes to 512 bytes and finally the data starts at 512 bytes to the end.
To decipher you have to use RSA method using sha256 as a oapesh, RSA_PKCS1_OAEP_PADDING as a padding and the public key that you create as a key.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Update webhook
\nHTTPS PATCH method that updates a webhook.\n
\n
\nThe fields url and name should be the same that you use on method POST Add Webhook.\n
\nThe filed type should be different tha you used before.\n
\nThe field id should be the same id that you obtained on method POST Add Webhook.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| name* | \nstring | \nfirst webhook | \n
\n\n| url* | \nstring | \nurl customize | \n
\n\n| type* | \nstring can be id or ocr | \nid | \n
\n\n| id* | \nstring | \nid obtained on add webhook | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Delete webhook
\nHTTPS DELETE method that deletes a webhook.\n
\n
\nThe field id should be the same id that you obtained on method POST Add Webhook.
\nRequest Model
\n\n\n\n| Key | \ntype | \nExample | \n
\n\n\n\n| id* | \nstring | \nid obtained on add webhook | \n
\n\n
\n
Response
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Get webhooks
\nHTTPS GET method that gives you an array of all your webhooks you have been created.
\nResponse
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJson object | \nJSON with useful information | \n
\n\n| 400 | \nJson ErrorMessage object | \nInvalid content | \n
\n\n| 401 | \nJson ErrorMessage object | \nUnauthorized. Invalid token | \n
\n\n
\n
Obtain Authentication Token
\nIn order to request access to VeriDocID API,
you must call the authentication method with your API client_id and client_secret,
along with a valid username and password.
Once validated, you will receive an authorization token, which must be used to call face API methods.
\n\n\n\n| Endpoint | \nHTTP Method | \n
\n\n\n\n| auth/token | \nPOST | \n
\n\n
\n
Request Parameters:
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\n| grant_type | \nstring | \nClient Credentials grant type is used by clients to obtain an access token outside of the context of a user. | \n
\n\n| client_id | \nstring | \nyour Client Id | \n
\n\n| client_secret | \nstring | \nYour client secret | \n
\n\n| audience | \nstring | \nveridocid | \n
\n\n
\n
Response:
\nIf request is correct, you will receive a Success response with the access token generated.
This token is only valid for a short period, exposed in the expires_in property.
\n\n\n\n| HTTP Code | \nBody | \nDescription | \n
\n\n\n\n| 200 | \nJSON Authorization object | \nValid OAuth token for request authorization | \n
\n\n| 400 | \nJSON ErrorMessage object | \nInvalid ClientId | \n
\n\n| 400 | \nJSON ErrorMessage object | \nUnsupported grant type | \n
\n\n| 500 | \nJSON ErrorMessage object | \nInternal Error | \n
\n\n
\n