Description (Company's Document List)
Show the business registration related with the company. (GET)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/br
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 Business Registration Information (id, file_id etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | ID of the BR |
2 | file_id | String | ID of the BR file |
3 | company_id | String | ID of the company related to the BR |
4 | company_name | String | Name of the company related to the BR |
5 | type_of_business | Integer | Type of buisness registered via the BR |
6 | registered_company_name | String | Company name displayed on the BR |
7 | br_number | String | Business Registration number of the company |
8 | branch_number | String | Branch number of the company |
9 | is_expired | Boolean | Whether the Business Registration is expired |
10 | expiry_date | String | Expiry date of the Business Registration (Format: YYYY-MM-DD) |
11 | status | String | Status of the Business Registration (ACTIVE or INACTIVE) |
12 | updated_at | String | Datetime business registration last updated (Format: YYYY-MM-DD hh:mm:ss) |
Example Success Response
{ "success": true, "data": { "id": "7E52LGO206XZ68YJDQ", "file_id": "80P79LK9JNJZVXJ1DQ", "company_id": "G2R98WZX3JMO5EV3PN", "company_name": "xxxxxxx", "type_of_business": 1, "registered_company_name": "xxxxxxx", "br_number": "37396313", "branch_number": "010", "is_expired": "true", "expiry_date": 2023-06-03, "status": "INACTIVE", "updated_at": 2023-06-03 06:47:57 } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.61.15-20230523 © The Payment Cards Group Limited. All rights reserved.