Add Company Details
URL: /api/v1/custom-onboarding/
Method: POST
Auth required: YES
Payload
| Key | Type | Value |
|---|---|---|
| reference_id | string | reference_id of the Client |
| details | string | It'll contain the details data |
Payload Example
{
"reference_id": "1701073563716-9657",
"details": {
"company_name": "Name",
"company_number": "123456",
"country_code": "GB",
"jurisdiction_code": "England-wales",
"type": "PLC",
"status": "active",
"address": "London, UK",
"website": "www.abc.com",
"phone": "+880123323",
"officers": [
{
"name": "abc",
"position": "director",
"address": "London, UK",
"start_date": "2022-01-01",
"end_date": null,
"country": "United Kingdom"
},
{
"name": "abc",
"position": "director",
"address": "London, UK",
"start_date": "2022-01-01",
"end_date": null,
"country": "United Kingdom"
}
],
"filings": [
{
"date": "2023-10-10",
"description": "capital allotment shares"
},
{
"date": "2023-10-10",
"description": "capital allotment shares"
}
],
"significant_persons": [
{
"name": "abc",
"last_name": "deff",
"nationality": "Indian",
"nature_of_control": "Ownership of shares 75 percent",
"ceased_on": "2021-10-10",
"type": "individual",
"date_of_birth": "1998-10-10",
"address": "London, UK",
"equity": "56",
"region": "London",
"country": "England"
},
{
"name": "abc",
"last_name": "deff",
"nationality": null,
"nature_of_control": "Ownership of shares 25 percent",
"ceased_on": "2021-10-10",
"type": "corporate",
"date_of_birth": null,
"address": "London, UK",
"equity": "56",
"region": "London",
"country": "England"
}
]
}
}
Response
| Field | Type | Description |
|---|---|---|
| status_code | int | Status code of the request |
| message | string | Client details created Successfully / Failed |
| data | object | This response will have nothing in data |
Response Example
{
"status_code": 200,
"message": "Client created successfully",
"data": null
}