List document types

GET/partner/v1/business-profiles/document-types

Auth Bearer tokenScope partner.read

Every code you may send as documentCategory for an upload with purpose set to BusinessDocument, with its label, a description of what is acceptable, and the formats and size limit used when the customer's configuration does not list it. Compliance adds codes without a release, so read this list rather than hard-coding it.

Response

documentTypesarray

One entry per code, grouped by category and ordered by displayOrder.

documentTypes[].codestring

Send this as documentCategory.

documentTypes[].displayNamestring

documentTypes[].categorystring

A grouping for display, such as Company formation.

documentTypes[].descriptionstring | null

What the document is and what makes it acceptable.

documentTypes[].defaultAllowedFileFormatsstring[]

For example ["pdf", "jpg", "jpeg", "png"].

documentTypes[].defaultMaxFileSizeMbinteger

At most 10.

Errors

Only the common errors.

Request

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

Response

{
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN...",
  "value": {
    "documentTypes": [
      {
        "code": "CERTIFICATE_OF_INCORPORATION",
        "displayName": "Certificate of Incorporation",
        "category": "Company formation",
        "description": "Issued by the company registry.",
        "displayOrder": 10,
        "customerUploadable": true,
        "defaultAllowedFileFormats": ["pdf", "jpg", "jpeg", "png"],
        "defaultMaxFileSizeMb": 10,
        "isActive": true
      }
    ]
  }
}