Skip to main content
Not sure which flow applies to your account? Start with Overview & which flow applies.

​
How it works

This is the flow for partners that are not regulated entities. You collect the user’s data in your own UI and submit it through the API, as in every KYC. Ripio then processes that data and asks the user to prove who they are: the response includes a provider_url where the user uploads their ID document and completes a liveness check with the identity provider. The verification ends asynchronously, once the identity provider reports back. Until then the KYC Submission stays IN_REVIEW.

​
The flow

1

Get the KYC requirements

Call KYC Requirements to get the fields required for your account’s country.
2

Create the KYC Submission

Call Create KYC Submission with the user’s email, the kyc_submission data and, optionally, the redirect_url to send them back to. The response comes back IN_REVIEW, with a provider_url:
Response
Save the submission_id to follow the verification.
3

Redirect the user to provider_url

Open provider_url in the user’s browser or in a webview. That page is Ripio’s KYC platform: the user uploads their ID document and completes the liveness check there, so you don’t build any document-capture screen.When they finish, they are sent back to the redirect_url you sent when creating the KYC Submission (https, worldapp or worldappstg schemes), so you can bring each user back to their own screen or deep link. If you don’t send one, the redirect URL configured for your account is used; if neither exists, the request answers 400 with code 20092.
4

Get the result

You get the outcome in two ways:While the verification is in progress you may also receive KYC.IN_REVIEW notifications. Act on the final status only.In sandbox, you can decide the outcome yourself to test both cases: see KYC in sandbox.
provider_url carries a token bound to this user’s verification process. Treat it as a secret: do not log it, share it or reuse it for another user.
A successful response does not mean the KYC is approved: it only means the verification was opened. The final status comes from the identity provider, after the user goes through provider_url.If the submission ends FAILED, you can create a new one for the same user. If the user already has an approved KYC, a new submission is rejected.