Description (Show Certificate of Incorporation)
Show the selected CI. (GET)
End Point
https://api.yedpay.com/v1/certificate-of-incorporation/{{ci_id}}
Variable
# | Name | Type | Description |
---|---|---|---|
1 | ci_id | String | Certificate of Incorporation'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 | 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
# | 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": "3WJ2PMK6XR1O7Y6DN5", "file_id": "9302L8KRRPMKEPRYJ7", "company_id": "7VEXG3O8X8NKY4PD0N", "company_name": "xxxxxxx", "ci_number": "12228211", "date_of_establishment": 2022-08-11, "status": "ACTIVE", "updated_at": 2022-08-11 08:05:54 } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.59.0-20220801 © The Payment Cards Group Limited. All rights reserved.