List Documents

GET 
/v1/merchants/:merchant_id/documents

Retrieve all documents for a merchant

Request

Path Parameters

merchant_id uuidrequired
Example: 82ce962d-a4b0-4ec8-9955-b6e14c4f11e9
type DocumentType

Possible values: [activity_license, bank_iban_certificate, commercial_registration, company_address, freelance_certificate, investment_license, official_letter, owner_address, owner_id, power_of_attorney, signatory_address, signatory_id, vat_certificate, memorandum_of_association, other]

Responses

200

Successful response

application/json

Schema

Schema

documents

object[]

Array [

id uuid

type DocumentType (string)

Possible values: [activity_license, bank_iban_certificate, commercial_registration, company_address, freelance_certificate, investment_license, official_letter, owner_address, owner_id, power_of_attorney, signatory_address, signatory_id, vat_certificate, memorandum_of_association, other]

info

object

oneOf

ActivityLicenseInfo

Activity License. Needed when the activity in CR requires one.

number string

Possible values: <= 255 characters

Activity license number.

BankCertificateInfo

Official Bank IBAN Certificate

holder stringrequired

Possible values: <= 255 characters

IBAN holder person/entity name as registered on bank records.

iban stringrequired

Possible values: >= 24 characters and <= 24 characters, Value must match regular expression ^SA\d{22}$

Valid IBAN number for the card holder

CommercialRegistrationInfo

Commercial Registration for the merchant business.

number stringrequired

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^[17]\d{9}$

Must be a valid CR number (starts with 1) or a valid unified number (starts with 7).

CompanyAddressInfo

name string

Possible values: <= 255 characters

street string

Possible values: <= 255 characters

district string

Possible values: <= 255 characters

building_number string

Possible values: <= 255 characters

secondary_number string

Possible values: <= 255 characters

postal_code string

Possible values: <= 255 characters

city string

Possible values: <= 255 characters

country Country (string)

ISO-3166-1 alpha-2 country code.

OwnerAddressInfo

name string

Possible values: <= 255 characters

street string

Possible values: <= 255 characters

district string

Possible values: <= 255 characters

building_number string

Possible values: <= 255 characters

secondary_number string

Possible values: <= 255 characters

postal_code string

Possible values: <= 255 characters

city string

Possible values: <= 255 characters

country Country (string)

ISO-3166-1 alpha-2 country code.

SignatoryAddressInfo

name string

Possible values: <= 255 characters

street string

Possible values: <= 255 characters

district string

Possible values: <= 255 characters

building_number string

Possible values: <= 255 characters

secondary_number string

Possible values: <= 255 characters

postal_code string

Possible values: <= 255 characters

city string

Possible values: <= 255 characters

country Country (string)

ISO-3166-1 alpha-2 country code.

FreelanceCertificateInfo

Freelance Certificate

number stringrequired

Possible values: <= 255 characters

Freelance certificate number.

expiry_date daterequired

InvestmentLicenseInfo

Investment License issued by the Ministry of Investment

number stringrequired

Possible values: <= 255 characters

Investment license number.

expiry_date daterequired

OwnerIdInfo

id stringrequired

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^[12]\d{9}$

A valid Saudi or Expat government ID

mobile stringrequired

Possible values: >= 10 characters and <= 10 characters

A valid Saudi mobile number

date_of_birth daterequired

SignatoryIdInfo

id stringrequired

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^[12]\d{9}$

A valid Saudi or Expat government ID

mobile stringrequired

Possible values: >= 10 characters and <= 10 characters

A valid Saudi mobile number

date_of_birth daterequired

PowerOfAttorneyInfo

Power of Attorney issued by the Ministry of Justice that gives a person the ability to sign on agreements.

number stringrequired

Possible values: <= 255 characters

Power of Attorney reference number.

VatCertificateInfo

VAT certificate if the business is required to pay taxes by law. The name must match the one in Commercial Registration.

number stringrequired

Possible values: <= 255 characters

Investment license number.

OtherInfo

Any type of document that is not categorized.

description required

file_uploaded boolean

]

meta

object

current_page integer

next_page integer

prev_page integer

total_pages integer

total_count integer

Example (from schema)

{
  "documents": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "activity_license",
      "file_uploaded": true
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

404

One of the record referenced in the request was not found

application/json

Schema

Schema

type string

Possible values: [record_not_found]

message string
errors object

Example (from schema)

{
  "type": "record_not_found",
  "message": "The <object type> record you were looking for was not found.",
  "errors": null
}

Loading...