Queue - Validación KYC

Endpoint para crear objetos en la cola de procesamiento relacionados con la validación KYC (Know Your Customer).

📥 Collection Postman

Descargar Collection - Queue Integration

URLs

Método	URL	Acción	Descripción
POST	/api/v1/integration/queue	Registrar	Crea un objeto en la cola de procesamiento para validación KYC
GET	/api/v1/integration/queue/{id}	Visualizar	Verifica el estado de procesamiento de un objeto en la cola

Producción:

{connect-producao}/api/v1/integration/queue

Homologación:

{connect-homologacao}/api/v1/integration/queue

Autenticación

Todas las solicitudes requieren un token de acceso obtenido en el endpoint de Security. El token debe ser enviado en el header AccessToken.

Crear Objeto en la Cola

Solicitud

Endpoint: POST {connect-producao}/api/v1/integration/queue

Headers:

AccessToken: {access_token}
Content-Type: application/json

Body:

{
  "action": "kyc-validation",
  "data": {
    "firstName": "Juan",
    "lastName": "Silva",
    "birthday": "1980-08-05",
    "UserId": 1329964,
    "SSOId": 123456789,
    "Identifier": "juan@ejemplo.com",
    "verified": true
  }
}

Campos del Body

Campo	Tipo	Obligatorio	Descripción
firstName	string	Sí	Primer nombre del usuario
lastName	string	Sí	Apellido del usuario
birthday	string	Sí	Fecha de nacimiento (formato YYYY-MM-DD)
UserId	number	Sí	ID del usuario en el sistema
SSOId	number	Sí	ID del usuario en el SSO
Identifier	string	Sí	Identificador del usuario (CPF o email)
verified	boolean	Sí	Indica si el identificador fue verificado

Respuesta de Éxito

Estado: 201 Created

{
  "id": "uuid-del-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Objeto creado con éxito",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Verificar Procesamiento

Solicitud

Endpoint: GET {connect-producao}/api/v1/integration/queue/{id}

Headers:

AccessToken: {access_token}

Respuesta de Éxito

Estado: 200 OK

{
  "id": "uuid-del-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Procesado con éxito",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "Validación KYC concluida",
  "msg": {
    "action": "kyc-validation",
    "data": {
      "firstName": "Juan",
      "lastName": "Silva",
      "birthday": "1980-08-05",
      "UserId": 1329964,
      "SSOId": 123456789,
      "Identifier": "juan@ejemplo.com",
      "verified": true
    }
  }
}

Ejemplo de Implementación

async function crearValidacionKYC(datosKYC, accessToken) {
  const response = await fetch('{connect-producao}/api/v1/integration/queue', {
    method: 'POST',
    headers: {
      'AccessToken': accessToken,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      action: 'kyc-validation',
      data: datosKYC
    })
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}