Available in🇮🇳 India
Some steps need the sub-merchant to act outside your form: enter a One-Time Password (OTP), or finish a DigiLocker, UPI or video KYC flow. Start these with Run an Action.
A requirement with requirement_type action names the action to run in its requirement_code. You never infer an OTP from a data field. An action never changes the account. Its outputs come back in the response’s metadata as type and value pairs. Its requirements list what is due next, exactly as the account’s requirements show it.
The table below lists the actions:
4.1 Send an OTP
Runsend_phone_otp or send_email_otp when it is due. The body is optional for these actions.
POST /v1/accounts/{account_id}/actions/{action}
PATCH /v1/accounts/{account_id}
Curl
200 with the code still due. An expired code, or 3 wrong tries, brings the send action back. To send a new OTP, run the action again with a new idempotency key.
4.2 Mint a Link
Runcreate_aadhaar_digilocker_link or create_upi_link when it is due. DigiLocker needs a return_url in metadata.
POST /v1/accounts/{account_id}/actions/{action}
account.requirements.updated webhook. To show the link again, or when it expires or the step fails, run the action again for a new link.
Request Parameters
Request Parameters
metadata.return_url mandatory for create_aadhaar_digilocker_link
: string The https URL the sub-merchant returns to after DigiLocker. For example, https://shop.example.com/rzp/aadhaar-done.metadata.ckyc_mobile optional for send_ckyc_otp
: string The mobile on the CKYC record, +91 followed by 10 digits. A number that is not the mobile on the record returns status: failed.4.3 Complete Video KYC
You never report the outcome of a video KYC call yourself. When video KYC is needed, usually after submission without a CKYC record, the product moves toedd_pending. Its one requirement is the create_video_kyc_link action.
Run it to get the link in the response’s metadata:
POST /v1/accounts/{account_id}/actions/{action}
under_review, then to activated or rejected. Each change comes back on the product’s status and requirements, and through webhooks.
4.4 Handle Action Failures
The table below lists how an action can fail:4.5 Fetch KYC From CKYC
CKYC verifies the person and fills their proof of address from their CKYC record. It applies to these people:- An individual
- A proprietor
- The authorised person of a private limited, public limited or Section 8 company
- Once the PAN verifies and Razorpay finds a CKYC record for it, the
ckyc_fetchcomposite requirement is due. To skip CKYC, sendtrueatbusiness_profile.authorized_person.identity_numbers.individual_ckyc.is_skipped. - Otherwise, run
send_ckyc_otp. Itsmetadatareturnssent_to,expires_atandrequest_id. Itsrequirementslistckyc_otpandckyc_request_id. - Ask the sub-merchant for the 6-digit code. Send it as
otp, with the request ID asrequest_id, onindividual_ckycin an update.
POST /v1/accounts/{account_id}/actions/{action}
PATCH /v1/accounts/{account_id}
Request Parameters
Request Parameters
business_profile.authorized_person.identity_numbers.individual_ckyc.otp optional
: string The 6-digit code sent to the mobile on the CKYC record. Send it with request_id. For example, 308217.business_profile.authorized_person.identity_numbers.individual_ckyc.request_id optional
: string The request ID from the send_ckyc_otp response. Send it with otp. For example, CKYCREQ20261115000123.business_profile.authorized_person.identity_numbers.individual_ckyc with these fields:
value:null.metadata: Theckyc_mobile, the mobile number on the CKYC record.verification: The outcome of the check.
otp or request_id.
Handy TipsA wrong code leaves
ckyc_otp and ckyc_request_id due. Send the corrected code with the same request ID. To send the code again, run send_ckyc_otp and use the new request ID. The earlier code then stops working.proof_of_address_for_individual composite requirement due instead. Answer it with DigiLocker through create_aadhaar_digilocker_link, or both sides of an Aadhaar, passport or voter ID. Know more about composite requirements. Without a CKYC record, a video KYC call can also be due after submission.