Queue - KYC Validation

Endpoint to create objects in the processing queue related to KYC (Know Your Customer) validation.

📥 Postman Collection

Download Collection - Queue Integration

URLs

Method	URL	Action	Description
POST	/api/v1/integration/queue	Register	Creates an object in the processing queue for KYC validation
GET	/api/v1/integration/queue/{id}	View	Checks the processing status of an object in the queue

Production:

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

Staging:

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

Authentication

All requests require an access token obtained from the Security endpoint. The token must be sent in the AccessToken header.

Create Object in Queue

Request

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

Headers:

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

Body:

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

Body Fields

Field	Type	Required	Description
firstName	string	Yes	User's first name
lastName	string	Yes	User's last name
birthday	string	Yes	Date of birth (format YYYY-MM-DD)
UserId	number	Yes	User ID in the system
SSOId	number	Yes	User ID in SSO
Identifier	string	Yes	User identifier (CPF or email)
verified	boolean	Yes	Indicates if the identifier was verified

Success Response

Status: 201 Created

{
  "id": "uuid-of-object",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Object created successfully",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Check Processing

Request

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

Headers:

AccessToken: {access_token}

Success Response

Status: 200 OK

{
  "id": "uuid-of-object",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Processed successfully",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "KYC validation completed",
  "msg": {
    "action": "kyc-validation",
    "data": {
      "firstName": "John",
      "lastName": "Silva",
      "birthday": "1980-08-05",
      "UserId": 1329964,
      "SSOId": 123456789,
      "Identifier": "john@example.com",
      "verified": true
    }
  }
}

Implementation Example

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

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

  return await response.json();
}