initiateUserKyc

The initiateUserKyc API is used to start the KYC verification process to validate the employee’s identity information.

What it does:

• Initiates identity verification using previously submitted KYC information

Note:

Kyc may only be initiated after using addKycInformation to submit the required information for verification.

POST /userOnboarding#initiateUserKyc

initiateUserKyc

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/userOnboarding#initiateUserKyc' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "initiateUserKyc",
  "userId": "e066e305-3816-4b06-8576-50d2502be436"
}
'

200

{
  "initiateKyc": {
    "userId": "e066e305-3816-4b06-8576-50d2502be436",
    "status": "KYC Verification Initiated",
    "message": "The KYC Information for jacob king has been added successfully."
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

Example:

"initiateUserKyc"

userId · string<uuid> · required

Response

200

application/json

initiateKyc · object · required

Show child attributes