Skip to main content

KYC Flow

KYC Flow​

You can find the user onboarding status and KYC url by calling the following API with the user's phone number. This API can be used to check if the user is verified and if not, to get the KYC url to complete the verification process. Seller receives an SMS with a KYC link to verify his identity on contract creation, but you can also proactively check the user's onboarding status and get the KYC url by calling the following API:

apps/api/user/onboarding?phoneNumber=5555555 get user status and return a KYC url

Field NameTypeDescriptionRequired / Notes / Example
phoneNumberstringUser phone numberRequired

Example Response​

The response will include the onboardingUrl where the user can complete their KYC if externalHandleKyc is set to false. And isVerified indicates whether the user is absher verified, and kycCompleted indicates whether the KYC process is completed for the user. It also includes flags indicating whether onboarding is completed, where the user is absherVerified and KYC is completed.

{
    "data": {
        "platformRefId": "USR_123456",
        "onboarding": 
        {
            "url": "https://integration.wepay-sa.com/kyc?isVerified=true&isKycCompleted=false
                    &isBankAccountReady=true&callbackUrl=https://your-callback-url.com&token=encodedToken",
            "token": "encodedToken",
            "expiresAt": "2024-06-30T10:27:39.889Z"
        },
        "onboardingCompleted": false,
        "isVerified": false,
        "kycCompleted": false,
        "isBankAccountReady": false,
        "isWelcome": false
    },
    "message": "OnboardingRetrievedSuccessfully",
    "status": 200,
    "validationErrors": []
}

Note: On contract creation, the seller receives an SMS with a KYC link to verify his identity.