Requirements Resource

Requirements include the list of documents and details needed for onboarding either child merchants or merchant-related consumer accounts under a parent merchant. This resource is used with the Onboarding API to onboard new accounts. For detailed onboarding steps, refer to the Onboarding API guide.

Requirements Resource

{
    "data": {
        "attributes": {
            "features": [
                "payment_gateway"
            ],
            "business_type": "individual",
            "requirements": {
                "details": [
                    "accepted_terms_and_conditions",
                    "bank.account_name",
                    "bank.account_number",
                    "bank.id",
                    "business.address.city",
                    "business.address.line1",
                    "business.address.line2",
                    "business.address.postal_code",
                    "business.address.state",
                    "business.age",
                    "business.customer_service_number",
                    "business.description",
                    "business.estimated_monthly_volume",
                    "business.handle",
                    "business.industry",
                    "business.intended_product",
                    "business.physical_store",
                    "business.size",
                    "business.trade_name",
                    "business.type",
                    "business.website",
                    "features",
                    "representative.address.city",
                    "representative.address.line1",
                    "representative.address.line2",
                    "representative.address.postal_code",
                    "representative.address.state",
                    "representative.date_of_birth",
                    "representative.date_of_birth.day",
                    "representative.date_of_birth.month",
                    "representative.date_of_birth.year",
                    "representative.email_address",
                    "representative.first_name",
                    "representative.last_name",
                    "representative.mobile_number",
                    "representative.nationality",
                    "representative.nature_of_work",
                    "representative.place_of_birth.city",
                    "representative.place_of_birth.country",
                    "representative.permanent_address.city",
                    "representative.permanent_address.line1",
                    "representative.permanent_address.line2",
                    "representative.permanent_address.postal_code",
                    "representative.permanent_address.state",
                    "representative.source_of_funds",
                    "representative.source_of_funds_other",
                    "representative.source_of_funds_salary",
                    "representative.tin"
                ],
                "documents": [
                    "government_id",
                    "signed_moa"
                ]
            },
            "optional": {
                "details": [],
                "documents": []
            }
        }
    }
}

business_type string
Business type of the child merchant or consumer.


features array of string

List of features enabled for the child merchant or consumer.


requirements dictionary
Contains required details and documents of the child merchant or consumer.

AttributeDescription
details stringList of required details.
documents array of stringList of required documents.

optional dictionary
Optional details and document of the child merchant or consumer.

AttributeDescription
details stringList of required details.
documents array of stringList of required documents.