Queue - KYC Validation

📥 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

1 - Obter Token (client_credentials)

auth_url: https://security.fanbase.com.br
grant_type: client_credentials

Requisição

POST https://security.fanbase.com.br/api/token?grant_type=client_credentials&client_id={client_id}&client_secret={client_secret}

Resposta (exemplo)

{
  "access_token": "seu_access_token",
  "token_type": "Bearer",
  "expires_in": 3600
}

Autenticação via QueueApiKey

Como o processo de fila é baseado em uma interface (ifcode), também é permitido autenticar sem AccessToken, usando QueueApiKey:

A) Access Token

AccessToken: {access_token}

B) Api Key Header

X-Api-Key: {QueueApiKey}

C) Basic Auth

Authorization: Basic base64({ifcode}:{QueueApiKey})

D) HMAC - SHA256

X-Webhook-Id: {ifcode}
X-Webhook-Signature: sha256={assinatura_hex}

Fórmula:

HMAC-SHA256(secret, request_body) -> hex string -> prefixo "sha256="

2 - Criar objeto na fila de processamento

api_url: https://connect.fanbase.com.br

Body (ExemploQueueNewC / kyc-validation)

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

2.1 - Exemplo usando AccessToken

POST https://connect.fanbase.com.br/api/v1/integration/queue
AccessToken: {access_token}
Content-Type: application/json

2.2 - Exemplo usando X-Api-Key

POST https://connect.fanbase.com.br/api/v1/integration/queue
X-Api-Key: {QueueApiKey}
Content-Type: application/json

2.3 - Exemplo usando Basic Auth

POST https://connect.fanbase.com.br/api/v1/integration/queue
Authorization: Basic base64({ifcode}:{QueueApiKey})
Content-Type: application/json

2.4 - Exemplo usando HMAC-SHA256

POST https://connect.fanbase.com.br/api/v1/integration/queue
X-Webhook-Id: {ifcode}
X-Webhook-Signature: sha256={assinatura_hex}
Content-Type: application/json

Resposta de sucesso na criação

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
}

3 - Verificar processamento do objeto

Use o id retornado na criação:

GET https://connect.fanbase.com.br/api/v1/integration/queue/{id}
AccessToken: {access_token}

Também é possível consultar usando as alternativas de autenticação via QueueApiKey, conforme seção anterior.

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": "Joao",
      "lastName": "Exemplo",
      "birthday": "1980-08-05",
      "UserId": 1329964,
      "SSOId": 123456789,
      "Identifier": "joao@exemplo.com",
      "verified": true
    }
  }
}