v1/Customer/CreateCustomer

 

API parameters
Required

 

Name In Type Description Default
Bearer Token Authorization string Authentication token.
CustomerType Json Data string Customer Type Of the Company. Individual,Corporate
Name Json Data string Name Of the Company,Required Only in Corporate.
Type Json Data string Type Of the Company,Required Only in Corporate. LTD,LLP,Sole Trader,Others,Trust,Public Limited
SICCode Json Data string SICCode Of the Company,Required Only in Corporate.
RegistrationNumber Json Data string Registration Number Of the Company,Required Only in Corporate.
IncorporationDate Json Data string Incorporation Date Of the Company,Required Only in Corporate.
AddressLine1 Json Data string Address Of the Company,Required Only in Corporate.
City Json Data string City Of the Company,Required Only in Corporate.
PostCode Json Data string Post Code Of the Company,Required Only in Corporate.
Country Json Data string Country Of the Company,Required Only in Corporate.
Role Json Data string Position in Company,Required Only in Corporate. Director & Shareholder,Director,Shareholder
Title Json Data string Title of the contact. Sr,Dr,Miss,Mr,Mr & Miss,Mr & Mrs
FirstName Json Data string First Name of the contact.
LastName Json Data string Last Name of the contact.
DateOfBirth Json Data string Date Of Birth of the contact.
Nationality Json Data string Nationality of the contact.
Email Json Data string Email of the contact.
ISDCode Json Data string ISD Code of the contact.
MobileNumber Json Data string Mobile Number of the contact.
AddressLine1 Json Data string Address of the contact.
City Json Data string City of the contact.
PostCode Json Data string Post Code of the contact .
Country Json Data string Country of the contact.
Status Json Data string Contact status. Active,Inactive

 

 

 

Request

 

{   
  "CustomerType": "Corporate",
  "CompanyDetail":{
  "Name": "abc Company",
  "Type": "LTD",
  "SICCode": "123456",
  "RegistrationNumber": "789456",
  "IncorporationDate": "10-12-2019",
  "AddressDetail":{
  "AddressLine1": "TestAddress",
  "City": "TestCity",
  "PostCode":"HA298UE", 
  "Country": "GB"
  }
},    
  "ContactDetail":[{
  "Role": "Director",
  "Title": "Mr",
  "FirstName":"John", 
  "LastName": "Cena",
  "DateOfBirth": "1980-07-09",
  "Nationality":"GB", 
  "Email": "John@mailinator.com",
  "ISDCode": "44",
  "MobileNumber":"123456789", 
  "PrimaryContact": "true"
  "AddressDetail":{ 
  "AddressLine1": "Address1",
  "City": "Address2",
  "PostCode": "HA298UE",
  "Country": "GB"
  },
  {
  "Role": "Director",
  "Title": "Mr",
  "FirstName":"Roman", 
  "LastName": "Reigns"
  "DateOfBirth": "1990-05-07",
  "Nationality":"GB", 
  "Email": "Roman@mailinator.com",
  "ISDCode": "44",
  "MobileNumber":"123456789", 
  "PrimaryContact": "true"
  "AddressDetail":{ 
  "AddressLine1": "Address2",
  "City": "Address3",
  "PostCode": "HA298UE",
  "Country": "GB"
  }  
 }]
 
}

 

Response

 

{
    "CustomerId": "AEC04E14-75F9-4548-98A0-",
    "CustomerStatus": "Inactive",
    "ContactDetail":[
    {
     "ContactId": "60D47AE0-EF3B-444B-A375-",                                    
     "ContactStatus": "Inactive",
     "ActionRequired": "Uploaddocument",
    },
    {
     "ContactId": "23C64100-4F67-4FD2-A222-",                                    
     "ContactStatus": "Inactive",
     "ActionRequired": "Uploaddocument",
    }
   ]
}

 

Error Codes

 

HTTP Status Code Description
401 Invalid credentials Invalid credentials
400 Invalid JSON body Invalid JSON body
400 Customer type required Customer type required
404 Invalid customer type Invalid customer type
400 Company name required Company name required
400 Company type required Company type required
404 Invalid company type Invalid company type
400 Company SIC code required Company SIC code required
400 Company registration number required Company registration number required
400 Company incorporation date required Company incorporation date required
400 Company incorporation date should be in dd/mm/yyyy Company incorporation date should be in dd/mm/yyyy
400 Company incorporation date should not be a future date Company incorporation date should not be a future date
400 Company addressline1 required Company addressline1 required
400 Company city required Company city required
400 Company post code required Company post code required
400 Company country required Company country required
404 Invalid company country Invalid company country
400 Role required Role required
404 Invalid role Invalid role
400 Title required Title required
404 Invalid title Invalid title
400 First name required First name required
400 Last name required Last name required
400 Date Of birth required Date Of birth required
400 Date Of birth should be in yyyy-mm-dd Date Of birth should be in yyyy-mm-dd
400 Contact age should be greater than 18 years Contact age should be greater than 18 years
400 Nationality required Nationality required
404 Invalid nationality Invalid nationality
400 Email required Email required
404 Invalid email Invalid email
400 ISD code required ISD code required
404 Invalid ISD code Invalid ISD code
400 Mobile number required Mobile number required
400 Primary contact required Primary contact required
404 Invalid primary contact type Invalid primary contact type
400 Addressline1 required Addressline1 required
400 City required City required
400 Post code required Post code required
400 Country required Country required
404 Invalid country Invalid country