Add Organisation data
Adds data of the Organisation to the System. This information will be used in following Payments.
Endpoint
Request Type | URL |
|---|---|
POST | https://{EnvironmentURL}/kycp/organisations |
Headers
Parameter | Type | Mandatory | Description |
|---|---|---|---|
x-api-version | string | Yes | 1.0 |
Request body
Body - JSON
Parameter | Type | Mandatory | Description |
|---|---|---|---|
legalName | string | Mandatory | Legal name of the Organisation according to registration Documents |
brandName | string | Mandatory | Brand name |
registrationNumber | string | Mandatory | Registration number of the Organisation according to registration Documents |
dateOfIncorporation | string | Mandatory | Date in format YYYY-MM-DD |
countryOfIncorporationExtId | string | Mandatory | Identifier from Countries lookup. LookupId = 4 |
address | Location | Non mandatory | Registration address of the Organisation |
Location - object
Parameter | Type | Mandatory | Description |
|---|---|---|---|
countryExtId | int | Yes | Identifier from Countries lookup, Id = 4 |
state | string | No | State for Countries where applicable |
city | string | Yes | City name |
street | string | Yes | Street name |
building | string | Yes | Building name/number |
postCode | string | Yes | Postcode |
Responses
200 OK - Success
Body - JSON
Contains Id - identifier of created Organisation
401 - Unauthorized
No Body