All requests must first be Authorized and must use the HTTP POST method over HTTPS.

This call allows you to create a customer which will be assigned to your account in DigitalHub.

POST request format:

Endpoint:

https://api.vision-net.ie/cws/2.5/digital_hub/consumer/create

{ "clientReference": "{clientReference}", "firstName": "{firstName}", "surname": "{surname}", "country": { "name": "{country.name}", "nationality": "{country.nationality}" }, "currentCounty": { "name": "{currentCounty.name}" }, "previousCounty": { "name": "{previousCounty.name}" }, "dateOfBirth": "{dateOfBirth}", "email": "{email}", "phone": "{phone}", "address": "{address}" }

Parameters:

Parameter	Type	Description
clientReference	String	(Required) Client reference string, must be unique for every customer.
firstName	String	(Required) First name of the customer.
surname	String	(Required) Surname of the customer.
country	object	(Required) Country object with "name" string field for name of the country and "nationality" string field for nationality.
currentCounty	object	Current county object with "name" string field for name of the current county of the customer.
previousCounty	object	Previous county object with "name" string field for name of the previous county of the customer.
dateOfBirth	Date	(Required) Date of birth of the customer - format dd-MM-yyyy
email	String	Email of the customer.
phone	String	Phone number of the customer.
address	String	Address of the customer.

Sample response - json:

{ "pk": 286, "ownerId": "921859930000000000000000000848", "refno": "3", "firstName": "John", "lastName": "Deer", "dateOfBirth": -405475200000, "country": "Ireland", "currentCounty": "Cork", "previousCounty": "Laois", "address": "Street 12", "phone": "111222333", "email": "email@domain.com", "status": "ACTIVE", "dateInserted": 1667920379000, "userInserted": "921859930000000000000000000848", "gender": 0, "avgEidvScore": 0, "positiveFaceCheck": 0 }