Yedpay

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": "2NMJVPOMJL6O70RL8W",
                    "file_id": "6YEXR4KE7LJO3N8QG5",
                    "company_id": "R350MQONLM5ZEJDYL4",
                    "company_name": "xxxxxxx",
                    "ci_number": "71762734",
                    "date_of_establishment": 2022-08-11,
                    "status": "ACTIVE",
                    "updated_at": 2022-08-11 07:16:10
                }
            }

Example Error Response

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

v1.59.0-20220801 © The Payment Cards Group Limited. All rights reserved.