Check KYC Status & Send OTP
Checks the customer’s KYC status with Ripio to determine if they can be fast-tracked through onboarding.
There are three possible outcomes, and you should handle all three:
-
If the customer has a previously approved KYC with Ripio, this endpoint sends a One-Time Password (OTP) to their email and returns 200. You can then use the
POST /customers/{customerId}/otp/endpoint to validate the OTP and instantly approve the customer’s KYC with your service, skipping the full data submission process. -
If the customer’s KYC is not approved with Ripio, you get a 400
KycNotApprovedExceptionand must guide them through the standard KYC process. This involves retrieving the required fields viaGET /kycRequirements/and submitting their data usingPOST /customers/{customerId}/kyc/. -
If this customer already has an approved KYC on your integration, you get a 400
KycAlreadyApprovedExceptionand no OTP is sent. This is not an integration error — the customer is already verified and can transact, so treat it as a success and skip the OTP step. Note this check looks at the customer record on your integration, which is a different thing from whether the email has an approved KYC at Ripio.
The request body is optional: send email to look up a specific address, or omit it to use the email already stored on the customer.
Authorizations
Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.
Path Parameters
Unique identifier for the customer.
Body
Optional payload. Omit it entirely to use the customer's stored email.
Payload for checking KYC status. The body is optional, and so is email inside it.
Email to look up in Ripio. If omitted, the customer's stored email is used. If neither is available, the request fails with a 400.
Response
KYC approved in Ripio and OTP sent.
"kyc approved. Otp sent"