⚙️ Configure REL-ID to Send KYC Requests

This guide walks you through the configuration required in the REL-ID Gateway Management Console to enable the transmission of KYC identity data to your backend system.

🧭 Configuration Overview

You will need to:

1. Enable the KYC challenge in the user activation flow.
2. Set the API endpoint configuration in the Module Config Management.
3. Optionally configure encryption or bearer token authentication.

🔐 Step 1: Enable KYC Challenge in Activation Flow

1. Login to the Gateway Management Console.
2. Navigate to Authentication Management.
3. Edit the "First time activation" flow.
4. Add the challenge RELID-IDV-KYC before RELID-IDV-BiometricOptIn.
5. Save and restart the Blaze-Server.

✅

This ensures the KYC API is triggered immediately after successful ID scan and face match.

🌐 Step 2: Set KYC API Endpoint

Navigate to Module Config Management and configure the following:

• Component Name: IDV Server
• Config Name: kyc.service.api.config
• Config Value: JSON as shown below

{
  "method": "POST",
  "url": "https://127.0.0.1:9005/kyc",
  "headers": [{
  "headerName": "Content-Type",
  "headerValue": "application/json"
  }, {
  "headerName": "apiversion",
  "headerValue": "v2"
  }
  ],
  "requestEncryption": {
    "enable": <true/false>,
    "algorithm": "AES",
    "key": "<Encryption AES Key>",
    "ivParamSpec": "<Encryption IV Parameters>",
    "cipherSpec": "<Encryption Cipher Spec>",
    "blockSizeBytes": <Encryption Block size>
  },
  "responseDecryption": {
    "enable": <true/false>,
    "algorithm": "AES",
    "key": "<Decryption AES Key>",
    "ivParamSpec": "<Decryption IV Parameters>",
    "cipherSpec": "<Decryption Cipher Spec>",
    "blockSizeBytes": <Decryption Block size>
  },
  "requestBody": "",
  "responseBody": {
    "resultLocator": "result",
    "referenceNumberLocator": "reference_number",
    "userIdLocator": "user_id",
    "primaryUserIdLocator": "",
    "loginIdsLocator": "",
    "statusCodeLocator": "",
    "statusMessageLocator": "",
    "forUserIdLocator": "",
    "orchestrationUseCaseLocator": ""
  },
  "accessTokenEndpoint": {
    "url": "https://127.0.0.1:9005/kyc-service-access-token-endpoint",
    "headers": [{
      "name": <Header name>,
      "value": <Header value>
    }
    ],
  "method": <GET or POST>,
  "postParameters": [{
    "name": <Parameter name>,
    "value": <Parameter value>
    }
    ],
  "bodyParameter": <raw data to be sent in body >
  "accessTokenLocator": <access token locator>
  }
}

🔧 Top-Level Attributes

🔐 requestEncryption

Controls if the KYC request should be AES encrypted.

🔓 responseDecryption

Controls if the KYC API response should be decrypted.

📦 requestBody

Example Usages

📥 responseBody

Describes how to extract values from the KYC API response.

🔄 accessTokenEndpoint

Used to retrieve a dynamic OAuth2 Bearer token for Authorization header.

ℹ️

Use either postParameters or bodyParameter, not both. If both are provided, postParameters take precedence.

🔒 Supported Ciphers

🚦 Testing and Restart

1. After updating the config, click Restart on the IDV Server component.
2. Test activation flow on the REL-ID mobile app.
3. Monitor logs to ensure KYC API is triggered and response is parsed.