Guides

GetSupplierDocuments

Endpoint

Suggest Edits

Overview

The "GetSupplierDocuments" endpoint is a GET request. It is used to get the supplier documents. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is GetSupplierDocuments.

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

📘

Request Header

Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.

Request Model

The request is a GET request with the following parameters:

Input ParameterTypeDescription
SupplierCodeinteger

Response Model

The response is an array of SupplierFileView objects as follows:

Response FieldTypeDescription
FileUrl stringThe document URL.
FileType integer1 for Civil Id
2 for Commercial License
3 for Articles of Association
4 for Signature Authorization
5 for Others
6 for Civil ID Back
7 for Instagram
16 for Civil IDs of All Owners
17 for Civil ID of Manager
20 for Commercial Register
21 for Bank Account Letter
25 for Website
26 for 3rd Parties
27 for Basic regulations list (For charities only)
28 for Board of Directors Agreement (For charities only)
FileTypeName stringIt can be:
Commercial License, Signature Authorisation, Articles of Association, Civil ID, Civil ID back, 3-parties contract/ agreement, and Others.
ExpireDate string

Sample Message

/v2/GetSupplierDocuments?SupplierCode=69

[
    {
        "FileUrl": "https://sa.myfatoorah.com/Files/Suppliers/13756/dbdfd02d-be0b-4edf-b751-914142aa5437.jpeg",
        "FileType": 5,
        "FileTypeName": null,
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 1,
        "FileTypeName": "Civil Id",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 2,
        "FileTypeName": "Commercial License",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 4,
        "FileTypeName": "Signature Authorization",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 3,
        "FileTypeName": "Articles of Association",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 20,
        "FileTypeName": "Commercial Register",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 16,
        "FileTypeName": "Civil Ids Of All Owners",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 17,
        "FileTypeName": "Civil Id Of Manager",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 21,
        "FileTypeName": "Bank Account Letter",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 25,
        "FileTypeName": "Website",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 26,
        "FileTypeName": "3-parties contract/ agreement",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 27,
        "FileTypeName": "Basic regulations list (For charities only) ",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 28,
        "FileTypeName": "Board of Directors Agreement (For charities only)",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 30,
        "FileTypeName": "National address",
        "ExpireDate": null
    }
]

Updated 4 months ago