Yedpay

Description (Company's Document List)

Show the documents related with that company. (GET)

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/documents

Variable

# Name Type Description
1 company_id String Company's ID

Request Header

# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

# Name Type Description

Response

# Name Type Description
1 success Boolean Request Document List Success or Fail
2 data Array Include all Document Information (document_iD, name etc..)
3 meta Array Include all Pagination's Information (total, count, total_pages, etc..)

Success Response - data

# Name Type Description
1 id String Id of the Document
2 user_id String ID of the User
3 uploader_id String ID of the Uploader
4 type String Type of the Document
5 name String Name of the Document
6 description String Description of the Document
7 mime String Type of the Image
8 size Integer Size of the Document
9 shared Boolean Whether the document is Shared or Not
10 br_number String Business Registration number (for type='br' only)
11 branch_number Numeric String Branch number of the company (for type='br' only)<
12 expiry_date Date Expiry Date of the BR (for type='br' only)

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "user_id": "JwoMPpKy",
                        "uploader_id": "JwoMPpKy",
                        "type": "logo",
                        "name": "xxx.jpeg",
                        "description": "xxx",
                        "mime": "image/jpeg",
                        "size": 6800,
                        "shared": true
                    },
                    {
                        "id": "e4r94oJx",
                        "user_id": "JwoMPpKy",
                        "uploader_id": "JwoMPpKy",
                        "type": "br",
                        "name": "xxx.jpeg",
                        "description": "xxx",
                        "mime": "image/jpeg",
                        "size": 6800,
                        "shared": true,
                        "br_number": "12345678",
                        "branch_number": "000",
                        "expiry_date": "2018-12-12"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 2,
                        "count": 2,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }
        

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }
        

v1.22.0-20190710 © The Payment Cards Group Limited. All rights reserved.