Retrieve Compliance Profile of Contact

Verify the compliance status of a personal contact.

Note

The response includes an empty data object when the client is not linked to a compliance policy. For more information, contact Rapyd Client Support.

Parameters

Request Path Parameters

- ewallet
- ID of the Rapyd Wallet that this contact is associated with. String starting with ewallet_.
- contact
- ID of the contact. String starting with cont_.

Request Header Parameters

Response Parameters

- compliance_levels
- Indicates the degree to which this contact can use the wallet. One of the following:
  - level
    Compliance level. One of the following values:
    -1 - The wallet is restricted and cannot be used for any transactions.
    0 - The wallet is limited, and the contact must complete the identity verification process.
    1 - All transactions are allowed.
  - elements
    Aspects of identity for verification
    element_name
    Aspect evaluated. One of the following:
    ID Number
    Full Name
    Address
    Nationality
    Date Of Birth
    IDV - Selfie
    verified
    Indicates whether the element was evaluated for the identity verification process.

/v1/ewallets/:wallet/contacts/:contact/compliance_levels

Get contact’s compliance profile levels

curl -X get
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_16feaaa27c852f30214dd7b3b359e88c/contacts/cont_2712dd466167ed03fdb3b4aa49966f3e/compliance_levels
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "5c784146-993f-4d28-ad62-3d82e3ca7163"
    },
    "data": {
        "compliance_levels": [
            {
                "level": -1,
                "elements": []
            },
            {
                "level": 0,
                "elements": []
            },
            {
                "level": 1,
                "elements": [
                    {
                        "element_name": "ID Number",
                        "verified": true
                    },
                    {
                        "element_name": "Full Name",
                        "verified": false
                    },
                    {
                        "element_name": "Address",
                        "verified": true
                    },
                    {
                        "element_name": "Nationality",
                        "verified": false
                    },
                    {
                        "element_name": "Date Of Birth",
                        "verified": false
                    },
                    {
                        "element_name": "IDV - Selfie",
                        "verified": false
                    }
                ]
            }
        ]
    }
}

In this section:

Documentation