Get document requirements

GET/partner/v1/business-profiles/{customerId}/requirements

Auth Bearer tokenScope partner.read

The documents this business must upload, for its business type, from the onboarding configuration it was held to when it started onboarding. A configuration Compliance publishes later does not change this list for a business already started. A business not yet held to a configuration is held on this first read to the one active at that moment.

Upload each documentTypeCategory with Request upload link, with purpose set to BusinessDocument and the code as documentCategory, at most maxFileSizeMB and in one of allowedFormats: these are this business's limits. The format is checked when you request the link; the size is checked when the file reaches storage, and a larger file is not accepted. This route says what is required, not what has been uploaded.

Path

customerIduuidpathrequired

From Create business profile.

Response

requiredDocumentsarray

Ordered by displayOrder.

requiredDocuments[].documentTypeCategorystring

Send this as documentCategory, with purpose set to BusinessDocument.

requiredDocuments[].labelstring

The document's name, to show to the business.

requiredDocuments[].descriptionstring | null

What the document is and what it must show.

requiredDocuments[].categorystring | null

The group the document belongs to, for example Company formation. Use it to group the list.

requiredDocuments[].forBusinessTypeboolean

true when the document is asked only because of the business's type, not of every business.

requiredDocuments[].isRequiredboolean

Optional documents never block submission.

requiredDocuments[].minimumDocumentsinteger

requiredDocuments[].maximumDocumentsinteger

requiredDocuments[].allowedFormatsstring[]

requiredDocuments[].maxFileSizeMBinteger

At most 10. Checked when the file reaches storage; no size is sent with the upload link request.

businessTypeCodestring | null

The business type the list was chosen for. null when the business has none recorded.

businessTypeNamestring | null

requiredCountinteger

How many documents have isRequired set. optionalCount counts the rest.

configurationVersionuuid

The configuration this business is held to.

customerTypeinteger

1 for a business.

Errors

Code	HTTP	When
Customer.NotFound	404	No customer with this id exists.
Customer.NotBusiness	400	The id belongs to a non-business customer.
Partner.NotAuthorized	403	The customer belongs to a different partner.
OnboardingConfig.NotFoundForCustomer	404	No requirements are configured for the business's country yet. Contact support.
OnboardingConfig.HighRiskCountryRequiresSetup	409	The business's country needs its own onboarding setup first. Contact support.

Request

curl https://gateway.sandbox.rynopay.io/api/partner/v1/business-profiles/b3f1c2d4-.../requirements \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

{
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN...",
  "value": {
    "countryId": "5c2e...",
    "countryName": "Nigeria",
    "countryIso3": "NGA",
    "customerType": 1,
    "requiredDocuments": [
      {
        "documentTypeCategory": "CERTIFICATE_OF_INCORPORATION",
        "label": "Certificate of Incorporation",
        "isRequired": true,
        "minimumDocuments": 1,
        "maximumDocuments": 2,
        "allowedFormats": ["pdf"],
        "maxFileSizeMB": 10,
        "displayOrder": 1,
        "description": "Issued by the company registry.",
        "category": "Company formation",
        "forBusinessType": false
      }
    ],
    "configurationVersion": "9a41...",
    "effectiveDate": "2026-09-01T00:00:00Z",
    "isDefaultConfiguration": false,
    "businessTypeCode": "Corporate",
    "businessTypeName": "Corporates",
    "requiredCount": 1,
    "optionalCount": 0
  }
}