---
title: "Documents required for merchant order"
method: GET
path: "/orders/{orderId}/required-documents"
tags: ["Merchant Orders Documentation"]
---

# Documents required for merchant order

`GET /orders/{orderId}/required-documents`

Docs required for merchant order

## Path parameters

- `orderId` string, uuid, required — Verifone allocated ID for the Order.

## Response `202`

Required Document list

- RequiredDocument[]
  - `documentId` string, uuid, required — Unique identifier for the document.
  - `documentName` string, required — Name of the document.
  - `displayName` string — Display name of the document shown to end user.
  - `status` 'PENDING_UPLOAD' | 'UPLOADED' | 'PENDING_SCAN' | 'ACCEPTED_CLEAN' | 'REJECTED_INFECTED', required — Current status of the document. Rejected documents must be re-uploaded.
  - `allowedContentTypes` ContentTypeEnum[], required — List of supported content types.
  - `allowedContentLength` integer — Size of the uploaded document in bytes. Default is 2 MB (2097152 bytes), maximum allowed is 8 MB (8388608 bytes).
  - `contact` ContractContactType
    - `contactType` 'BUSINESS' | 'DISPUTE_HANDLING' | 'OWNER' | 'PERSONAL', required — An indicator for the type of contact. |Value|Description| |----|-----------| |BUSINESS|Generic business contact information, e.g. info@example.com| |DISPUTE_HANDLING|Generic contact information specific to dispute handling, e.g. disputes@example.com| |OWNER|Individual contact information of the owner of the Entity, e.g. ben.jerry@example.com| |PERSONAL|Personal contact information of the person representing the Entity, e.g. bjerr83@example-personal-email-domain.com|
    - `name` ContactName, required — An object representing the name or component names of a party, person or business. No elements are mandatory due to the different usages, but the business rules need to be applied in the context where name is used.
      - `firstName` string, required — The given name of contact.
      - `lastName` string, required — The surname name or family name of the contact. This is required when the name is for a party or person. Can also include the matronymic or mother's family name where this is customarily used.
      - `prefix` string — The prefix to the party name. This is sometimes referred to as a title, salutation or appellation.
      - `alternateFullName` string — The alternate name for the party. This can be a business name or nickname. This should be used where the name of the party cannot be parsed into its constituent parts such as first name or last name. If the party is a business then this should always be present.
      - `middleName` string — The middle name or names for a party or person.
      - `suffix` string — The name suffix for the party.
    - `phoneNumbers` Phone[] — The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.
      - `callingCode` string — Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE
      - `value` string, required — The actual phone number less country code and/or extension.
      - `extension` string — The internal extension number where applicable or known.
      - `isPrimary` boolean — Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY
      - `phoneType` 'HOME' | 'MOBILE' | 'WORK' | 'FAX' | 'OTHER', required — Phone type in PHONE_TYPE_CON. Mapped to PARTY_PHONE.PHONE_TYPE_CON_ID or VENUE_PHONE.PHONE_TYPE_CON_ID
    - `email` string, email — A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1.
    - `businessTitle` string
    - `passportId` string — Passport Identity Identifier.
    - `nationality` string — Nationality
    - `additionalNationalities` string[] — Additional Nationalities
    - `nationalIdentifer` string — Contact's national identity identifier.

## Other responses

- `400` — Bad Request
- `401` — Unauthorised Request
- `403` — Forbidden Request.
- `404` — Not Found Request
- `429` — Too Many Requests
- `500` — Internal Error
- `503` — Service Not Available
- `504` — Service Timeout

---

[API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)