Yedpay API Documentation

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

Variable
#	Name	Type	Description
1	company_id	String	Company's ID

Request Header

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

Body

Body
#	Name	Type	Description

Response

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

Success Response - data
#	Name	Type	Description
1	id	String	Id of the File
2	user_id	String	Id of the User
3	type	String	Type of the File
4	name	String	Name of the File
5	description	String	Description of the File
6	mime	String	MIME Type of the File
7	size	Integer	Size of the File
8	shared	Boolean	Whether the File is Shared or Not (true/false)
9	br_number	String	Business Registration number (for type="br" or "store_br" only)
10	branch_number	Numeric String	Branch number of the BR (for type="br" or "store_br" only)
11	registered_company_name	String	Company name displayed in the BR (for "br" type file only)
12	type_of_business	Integer	Type of business registered via the BR (for "br" type file only)
13	expiry_date	String	Expiry Date of the BR (format: yyyy-MM-dd) (for type="br" or "store_br" only)
14	ci_number	String	Number of the CI (for last "ci" type file only)
15	ir_number	String	Number of the IR (for last "ir" type file only)
16	company_name	String	Company name displayed in the CI/IR (for last "ci" / "ir" type file only)
17	date_of_establishment	String	CI's date of establishment (format: yyyy-MM-dd) (for last "ci" type file only)

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "Q1N07LOJW3WZ35P2GD",
                        "user_id": "Q1N07LOJWQLZ35P2GD",
                        "uploader_id": "2NMJVPOMLMPK70RL8W",
                        "fileable_type": "App\Models\Company",
                        "fileable_id": "6YEXR4KE65DK3N8QG5",
                        "type": "ci",
                        "name": "xxxxxxxxxxxx",
                        "description": "xxxxxxxxxxxxx",
                        "mime": "xxxxxxx",
                        "size": 553126,
                        "shared": false,
                        "updated_at": 2023-11-28 22:18:13,
                        "ci_number": "51554096",
                        "company_name": "xxxxxxxxxxxx",
                        "date_of_establishment": "2023-11-28"
                    },
                    {
                        "id": "6PEQD4O4M4LZ5VY8W3",
                        "user_id": "Q1N07LOJ82DO35P2GD",
                        "uploader_id": "Q1N07LOJYQDO35P2GD",
                        "fileable_type": "App\Models\Company",
                        "fileable_id": "7V8GMYOWLNJZEJ5NL2",
                        "type": "br",
                        "name": "xxxxxxxxxxxx",
                        "description": "xxxxxxxxxxxxx",
                        "mime": "xxxxxxx",
                        "size": 278938,
                        "shared": false,
                        "updated_at": 2023-11-28 22:18:13,
                        "registered_company_name": "xxxxxxxxx",
                        "type_of_business": 2,
                        "br_number": "15140933",
                        "branch_number": "003",
                        "expiry_date": "2023-11-28"
                    }
                ],
                "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
            }