Get KYC Rules

This API endpoint allows clients to retrieve the rules associated with a specific KYC workflow based on the document type.

This API endpoint allows clients to retrieve the rules associated with a specific KYC workflow based on the document type. The KYC rules provide clients with the necessary information on the mandatory fields and additional requirements for the KYC process.

Request Header:

• Authorization: Bearer [token] (required): The authentication token for accessing the API.

Response: Upon a successful request, the API will return a response containing the KYC rules associated with the specified document type.

Base URL

sdk.faceki.com

KYC Rules End Point API

https://sdk.faceki.com/kycrules/api/kycrules

GET https://sdk.faceki.com/kycrules/api/kycrules

Headers

Name	Type	Description
Content-Type:*	String	application/json
Authorization:*	String	Bearer [token]

200: OK

{
    "responseCode": 0,
    "data": {
        "_id": "123",
        "companyId": "1234",
        "__v": 0,
        "allowedCountries": [],
        "allowedKycDocuments": [
            "Passport"
        ],
        "allowedNationalities": [],
        "createdAt": "2023-06-08T06:50:21.354Z",
        "dataStorageTime": "FOREVER",
        "declined": {
            "redirect_url": "https://www.faceki.com",
            "message": "Declined!"
        },
        "invalid": {
            "redirect_url": "https://www.faceki.com",
            "message": "Invalid!"
        },
        "invalidDocuments": [],
        "isRecapturedDocumentInvalid": false,
        "link": "",
        "livenessCheckType": "MODERATE",
        "multiKYCEnabled": true,
        "status": "ACTIVE",
        "storedData": true,
        "success": {
            "redirect_url": "https://www.faceki.com",
            "message": "Success!"
        },
        "updatedAt": "2023-06-10T12:01:25.835Z",
        "validAge": 18
    }
}

400: Bad Request

{
    // Response
}

401: Unauthorized

{
    // Response
}

403: Forbidden

{
    // Response
}

404: Not Found

{
    // Response
}

500: Internal Server Error

{
    // Response
}

Method: GET

Authorization: Bearer Token

By utilizing the "Get KYC Rules" API, clients can retrieve the specific rules and requirements associated with different KYC workflows, allowing them to tailor their user interfaces and data collection processes accordingly. This enhances the overall user experience and ensures compliance with KYC regulations.