API parameters
Required
Name |
In |
Type |
Description |
Bearer Token |
Authorization |
string |
Authentication token. |
CustomerId
|
Parameter |
string |
CustomerId. |
Optional
Response
[
{
"CustomerType": "Corporate",
"Status": "Inactive",
"Company":{
"Name": "ABC XYZ",
"Type": "LTD",
"RegistrationNumber": "789456",
"SICCode": "123456",
"IncorporationDate": "29-01-2020",
"Address":{
"Address": "TestAddress",
"City": "TestCity",
"Postcode": "HA298UE",
"Country": "GB"
}
},
"Contacts":[{
"FirstName": "John",
"LastName": "Smith",
"DateofBirth": "07-09-1980",
"Occupation": "Director",
"Nationality": "GB",
"PhoneNumber": "+44 810873325144",
"Email": "John@test.com",
"PrimaryContact": "false",
"Status": "Inactive",
"Address":{
"Address": "Test Address",
"City": "London",
"PostCode": "396185",
"Country": "GB"
}
},
{
"FirstName": "Paul",
"LastName": "John",
"DateofBirth": "07-09-1980",
"Occupation": "Director",
"Nationality": "GB",
"PhoneNumber": "+44 81087322351444",
"Email": "Paul@test.com",
"PrimaryContact": "true",
"Status": "Inactive",
"Address":{
"Address": "Test Address",
"City": "London",
"PostCode": "396185",
"Country": "GB"
}
}
]
}
]
Error Codes
HTTP Status |
Code |
Description |
401 |
Invalid credentials |
Invalid credentials |
400 |
Customerid required |
Customerid required |
404 |
Invalid customerid |
Invalid customerid |