Yedpay API Documentation

Description (Show Certificate of Incorporation)

Show CI of the selected company. (GET)

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/certificate-of-incorporation

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	Show Targeted CI's Information Success or Fail
2	data	Array	Include Targeted CI's Information (id, file_id, ci_number etc..)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	ID of the CI
2	file_id	String	ID of the CI file
3	company_id	String	ID of the company related to the CI
4	company_name	String	Company name displayed in the CI
5	ci_number	String	Number of the CI
6	date_of_establishment	String	CI's date of establishment (format: YYYY-MM-DD)
7	status	String	Status of the Certificate of Incorporation (ACTIVE or INACTIVE)
8	updated_at	String	Datetime the CI last updated (format: YYYY-MM-DD hh:mm:ss)

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "M49E60Z7WW3O17G5DN",
                    "file_id": "3GWX1LKVJRXKER4NYP",
                    "company_id": "WJ3459ZDJM9ZY1RP8V",
                    "company_name": "xxxxxxx",
                    "ci_number": "43696691",
                    "date_of_establishment": 2023-06-03,
                    "status": "ACTIVE",
                    "updated_at": 2023-06-03 05:48:15
                }
            }

Example Error Response

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