Create Custom Company Mandatory Data
URL: /api/v1/custom-company-mandatory-data/
Method: POST
Auth required: YES
Setup Process: This API is for creating the Custom Company Mandatory Data. In the payload, we need to pass reference_id of the client along with the company_name, company_number, country_code and jurisdiction_code. If any data is missing, we may use null for that particular field. If everything on point, we'll be able to create the mandatory data of the custom company.
Payload
| Key | Type | Value |
|---|---|---|
| reference_id | string | The reference ID of the company |
| company_name | string | Full name of the company |
| company_number (optional) | string | Company registration number |
| country_code | string | Country Code of the Company |
| jurisdiction_code (optional) | string | Jurisdiction code of the country |
Payload Example
{
"reference_id": "1719410364921-4202",
"company_name": "Shell",
"company_number": null,
"country_code": "GB",
"jurisdiction_code": null
}Response
| Field | Type | Description |
|---|---|---|
| status_code | int | Status code of the request |
| message | string | Company mandatory datas added successfully / Failed (with reason) |
| data | object | This should remain empty for this API |
Response Example
{
"status_code": 200,
"message": "Company mandatory datas added successfully",
"data": []
}