In the Immersve-conducted KYC mode, partner application directs their users to complete KYC through the Immersve UI. This contrasts with Partner Conducted KYC mode where Immersve is not directly involved with partners' cardholders.
We recommend this mode of KYC for partners not obligated to perform KYC as part of their main product, like crypto wallets. That's because implementing one's own KYC process can require a significant effort.
Integration steps
The following steps are for manual integration via a terminal. An integrating application should implement this flow with whatever technology stack is convenient.
Prerequisites
This guide assumes that the partner has already obtained an access token or API keys, and has the card program and funding source IDs ready.
token="<your_access_token>"
card_program_id="<your_card_program_id>"
funding_source_id="<funding_source_id>"
Request spending prerequisites
To begin the KYC process, call spending prerequisites specifying KYC type as immersve-conducted. Optionally, a redirectUrl can be provided to indicate where the user should be redirected upon completion of the KYC process.
Example Request:
curl -X POST "https://test.immersve.com/api/spending-prerequisites" \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $token" \
--data '{
"cardProgramId": "'${card_program_id}'",
"fundingSourceId": "'${funding_source_id}'",
"spendableAmount": 100,
"spendableCurrency": "USD",
"kycType": "immersve-conducted",
"kycRedirectUrl: "https://app.example.io",
"kycRegion":"NZL"
}'
Example Response:
{
"prerequisites": [
{
"type": "kyc",
"params": {
"status": "kyc_required",
"kycUrl": "https://verify.test.immersve.com/kyc/session/hg40904ddkr43?code=r938j9g"
}
},
]
}
If KYC is required, the response to the spending prerequisites request will contain a URL, where the user must be redirected to to complete the KYC verification. If KYC is not required, is already in progress, or the maximum number of retries has been exceeded, the URL will not be returned and the status will indicate the problem. See Spending Prerequisites endpoint reference for more details on possible statuses.
User goes through the KYC flow
Upon being redirected to the Immersve KYC page, the user will go through the process that involves the collection of the user's address and the verification of their identity through document and biometry (facial scan) collection.
At the end of the process they are presented with a screen indicating that their profile is under review. The user does not have to stay on the page to know the outcome, as it will be communicated via email. If they stay on the page, it will eventually inform about success or failure.
Upon exiting the page, users are sent back to the redirectUrl provided initially. If no URL was provided, exiting leads to closing the browser tab.
Confirmation of KYC Completion
Once redirected, check the spending prerequisites again to ensure no further KYC actions are required. Once there is no KYC prerequisite returned, and given all other checks are completed, the cardholder will be allowed to create and use their Immersve card.
Example Request:
curl -X POST "https://test.immersve.com/api/spending-prerequisites" \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $token" \
--data '{
"cardProgramId": "'${card_program_id}'",
"fundingSourceId": "'${funding_source_id}'",
"spendableAmount": 100,
"spendableCurrency": "USD",
"kycType": "immersve-conducted",
"kycRedirectUrl: "https://app.example.io",
"kycRegion":"NZL"
}'
Example Response:
{
"prerequisites": []
}
Testing
ID Verification (IDV) Without Real Documents: To support testing and simplify the integration process in test environments, we use mock documents. This allows testing the KYC verification workflow without putting real details into test environments.
The facial scan still needs to be done with the testing person's face, but no data will be stored in our test environment.
Below are the front and back images of a driver license that can be scanned with a phone camera directly:
Front of a drivers license
Back of a drivers license
