Available in🇮🇳 India
A requirement is something a product still needs from the sub-merchant. Each product lists its requirements in products.<product_type>.requirements. Razorpay computes them on every call. Show each requirement’s description to the sub-merchant. Answer it as its requirement_type says.
A stable, machine-readable identifier that names what a requirement is. For an
action, it is the action’s name. See Requirement Codes.How much the product needs it. Possible values:
mandatory: You cannot submit the product without it. A sub-requirement of anall_ofismandatoryunless it isoptional.conditional: Needed only in some cases and specific business type. For example, for business type Trust, if the merchant has Trust Registration Certificate, the Trust Registration Certificate must be uploaded during onboarding.optional: Not needed to submit the product, such as an address’s second line.
What the requirement is, which decides the other keys it carries. Possible values:
input: Send a value or a document atfield_pathwith Update an Account. Carriesfield_pathandvalue_type.action: Run the action named inrequirement_codewith Run an Action, such assend_ckyc_otp.composite: A requirement that groups other requirements insub_requirements. It is fulfilled when its child requirements satisfy itsfulfillment_criteria(one_of,any_oforall_of). It collects no value of its own.
Why the requirement was raised, such as a reviewer’s reason in
needs_clarification or a failed check. Present only when a review or a check raised the requirement.Only on
input. Where to send the value in an update, as a dot path, such as business_profile.authorized_person.identity_numbers.individual_pan. For a stakeholder, the path names the stakeholder: business_profile.stakeholders.<stakeholder_id>.…. For an address, the path picks the list item by its type: business_profile.addresses[type=registered_address].line1.Only on
input. What the input takes. Possible values:text: A value, such as a PAN number.enum: One ofoptions, such as a business type.multi_select: One or more ofoptions, sent as an array, such as the answer to a business-model question.boolean:trueorfalse, such asis_skippedto skip the Central KYC Records Registry (CKYC) record.document: A file: an uploaded document’sidor aurlfor Razorpay to download.
The files that answer a
document input. Know more about the Document entity.Only on
composite. How its sub_requirements answer it. Possible values:one_of: Answer any one sub-requirement, such as one proof of address.any_of: Answer one or more sub-requirements.all_of: Answer everymandatorysub-requirement, such as both sides of a document.
Only on
composite. The requirements that answer it. A sub-requirement can itself be a composite, so each item has the same keys as this entity.Where the requirement stands. Possible values:
created: The requirement has been raised.needs_clarification: A reviewer needs more information to validate the requirement.under_review: The response is submitted and Razorpay is evaluating it.resolved: The requirement is satisfied and closed.overdue: The requirement was not fulfilled by itsdue_atdeadline.rejected: The submitted response was reviewed and not accepted.expired: The requirement lapsed and is no longer actionable.cancelled: The requirement was withdrawn. No response is needed.
The deadline to fulfil the requirement, as a Unix timestamp in seconds. Present only when the requirement has a deadline.
An optional, free-form object of key-value pairs for extensibility on any requirement. It carries more context or configuration, such as what an action needs on an action requirement, without changing the requirement schema.
Keys per Requirement Type
A requirement carries only the keys itsrequirement_type uses. Every requirement carries id, requirement_code, requirement_level, requirement_type, description and status. It adds requirement_reason when a review or a check raised it and due_at when it has a deadline.
The table below lists the keys each type adds and how to answer it:
Composite Requirements
A composite requirement is fulfilled when its child requirements satisfy the node’sfulfillment_criteria (one_of, any_of or all_of). With one_of, answer any one sub-requirement. With any_of, answer one or more. With all_of, answer every mandatory sub-requirement.
The table below lists the inputs and actions inside each composite requirement, with the path to send each input at:
Requirement Codes
requirement_code comes from a closed list. Branch on it. For an action, it is the action’s name. Each business-model question adds one code, the question’s ID, such as bmc_question_31 or the follow-up bmc_question_13_1_1, that matches ^bmc_question_[0-9_]+$. Its description is the question.
Codes are unique among the sub-requirements of one composite. The same input can sit under 2 composites with the same code, such as gstin.
The table below lists requirement codes and the description each requirement carries: