Queue - KYC Validation

Endpoint para criar objetos na fila de processamento relacionados à validação KYC (Know Your Customer).

📥 Collection Postman

Baixar Collection - Queue Integration

URLs

Método	URL	Ação	Descrição
POST	/api/v1/integration/queue	Cadastrar	Cria um objeto na fila de processamento para validação KYC
GET	/api/v1/integration/queue/{id}	Visualizar	Verifica o status de processamento de um objeto na fila

Produção:

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

Homologação:

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

Autenticação

Todas as requisições requerem um token de acesso obtido no endpoint de Security. O token deve ser enviado no header AccessToken.

Criar Objeto na Fila

Requisição

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

Headers:

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

Body:

{
  "action": "kyc-validation",
  "data": {
    "firstName": "João",
    "lastName": "Silva",
    "birthday": "1980-08-05",
    "UserId": 1329964,
    "SSOId": 123456789,
    "Identifier": "joao@exemplo.com",
    "verified": true
  }
}

Campos do Body

Campo	Tipo	Obrigatório	Descrição
firstName	string	Sim	Primeiro nome do usuário
lastName	string	Sim	Sobrenome do usuário
birthday	string	Sim	Data de nascimento (formato YYYY-MM-DD)
UserId	number	Sim	ID do usuário no sistema
SSOId	number	Sim	ID do usuário no SSO
Identifier	string	Sim	Identificador do usuário (CPF ou email)
verified	boolean	Sim	Indica se o identificador foi verificado

Resposta de Sucesso

Status: 201 Created

{
  "id": "uuid-do-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Objeto criado com sucesso",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Verificar Processamento

Requisição

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

Headers:

AccessToken: {access_token}

Resposta de Sucesso

Status: 200 OK

{
  "id": "uuid-do-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Processado com sucesso",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "Validação KYC concluída",
  "msg": {
    "action": "kyc-validation",
    "data": {
      "firstName": "João",
      "lastName": "Silva",
      "birthday": "1980-08-05",
      "UserId": 1329964,
      "SSOId": 123456789,
      "Identifier": "joao@exemplo.com",
      "verified": true
    }
  }
}

Exemplo de Implementação

async function criarValidacaoKYC(dadosKYC, 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: dadosKYC
    })
  });

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

  return await response.json();
}