Guía del desarrollador para implementación de Access Token y Endpoints de KYC API Rest Service
Inicio
Esta guía explica cómo obtener el Access Token de Identidad Digital Global (IDG) para realizar llamadas a los endpoints de los servicio de biometría, lectura y extracción de datos de de documentos de identificación, las reglas de uso y el vencimiento del token.
IDG es un producto desarrollado por Global Bridge Connections, con marca registrada en Paraguay, Perú, Panamá y los Estados Unidos de América.
Audiencia
Esta guía está orientada para personas con conocimientos en API Rest y conceptos de programación que desean utilizar la API Rest de IDG.
Ambientes
El cliente dispondrá de dos ambientes totalmente independientes para utilizar los Endpoints de KYC API Rest Service y estas son:
Staging
Ambiente proveída al cliente para realizar sus pruebas y familiarizarse con el producto.
Los endpoints de KYC Api Rest Service requieren del id de cliente y de un Access Token como autorización, el cual debe ser generado por el cliente con la llave provista por Global Bridge Connections de manera confidencial a cada empresa cliente.
Un Basic Token, la cual deberá ser almacenada de forma segura de lado del cliente que utilizará los servicios de IDG.
Ambos datos también son accesibles desde el Portal KYC -> Mi Perfil
Obs: Las credenciales podrían ser distintas según el ambiente en la que opere.
{
"access_token": "85edecf8-f474-4f74-95a6-8e108a70d50b", //access token que sera utilizado como authorization en las llamadas a los endpoints de KYC
"token_type": "access_token",
"expires_in": 3600 // duracion en segundos del access token
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"code": string,
"message": string,
"data": {
"status": string,//Vigencia del documento
"reference": string,
"reference_image": string,//Imagen en base64 del carnet encontrado en el documento
"document_country": string,//codigo ISO3166-alpha3 de País del documento
"document_number": string,
"document_category": string,//categoria del documento
"first_name": string,
"last_name": string,
"first_last_name": string,
"second_last_name": string | null,
"date_of_birth": string | null,// Fecha de nacimiento con formato del documento
"date_of_birth_std": string | null,//Fecha de nacimiento con formato estandarizado
"mothers_name": string | null,
"fathers_name": string | null,
"address": string | null,
"mrz": string | null,
"date_expiry": string | null,
"nationality_code": string,//codigo ISO3166-alpha3 de Nacionalidad
"document_type": string,
"first_image": string,
"second_image": string,
"qa_moire_present": boolean,//Se observo patrones moire en el documento?
"qa_doc_incomplete": boolean,//El documento estába completo?
"qa_doc_out_perspective": boolean,//El documento estába fuera de perspectiva?
"qa_doc_out_focus": boolean,//El documento estaba fuera de foco?
"sex": string | null,//sexo que aparece en el documento
"marital_status": string | null,
"count_side_doc_analyzed": number,//cantidad de lados que se analizó del documento
"donor": string | null,
"height": number | null,
"blood_group": string | null
}
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"code": "string",
"message": "string",
"data": {
"similarity": number, //similitud entre rostros comparados 1= 100%
"validated_criteria": number, //valor de criterio de aceptación ingresada
"validated": boolean, // es similarity >= validate_criteria?
"validated_message": "string", //mensaje de validación
}
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"code": "string",
"message": "string",
"data": {
"result": string, //mensaje de si se encontro o no coincidencias
"match": [
{
"list_id": string, id de la lista
"list_description": string, //nombre de la lista
"list_category": string, //categoria de la lista
"names": string, //nombres con las que se encontraron coincidencias en la lista
"last_update": string, //fecha de la ultima actualización de la lista
"obs": {
"case": string, //motivo por la cual se encuentra en la lista
"authority": string, //agencia que se encargó de agregarle en la lista
"birth_place": string //lugar de nacimiento de la persona
}
}
] // array de listas de sanciones y/o pep en la que se encontraron coincidencias
}
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
{
"message": string, //mensaje de error
"data": [],
"code": string //codigo de error
}
