Endpoints

Prefix: https://[server]/gateway/[version]/

The current version is 1.2

When an error occurs, there will be an errors property with a list of errors applicable to the request:

Example:

{
    "errors": [{
    "errorcode":1317,
    "errordescription":"Missing request id”
    }]
}

Get/ping & Get/ping/{id}

Returns the status of the server.

Response Code	Description
200	Success

Field	Type	Format	Required	Values Allowed
firstName	String	Min 2 characters Max 25 characters	Yes	a-z, A-Z, hyphen, space Regex="^[a-zA-Z][- a-zA-Z']+$
LastName	String	Min 2 characters Max 25 characters	Yes	a-z, A-Z, hyphen, space Regex="^[a-zA-Z][- a-zA-Z']+$
MiddleInitial	String	Min 1 character Max 1 character	Yes	a-z, A-Z Regex=@"^[a-zA-Z]{1}$
AddressLine1	String	Min 0 characters Max 25 characters	Yes	a-z, A-Z, 0-9, hyphen, space, /, period Regex=@"^[a-zA-Z0-9][- a-zA-Z0-9/\.]{2,}$
AddressLine2	String	Min 0 characters Max 25 characters	No	a-z, A-Z, 0-9, hyphen, space, /, period Regex=@"^[a-zA-Z0-9][- a-zA-Z0-9/\.]{2,}$
City	String	Min 0 characters Max 25 characters	Yes	a-z, A-Z, hyphen, space Regex=@"^[- a-zA-Z]*$
State	String	Min 0 characters Max 2 characters	Yes	any word character Regex=@"^\w{2}?$
ZipCode	String	Min 5 characters Max 10 characters	Yes	0-9, hyphen Regex=@"^\d{5}(-?\d{4})?$
SSN	String	Min 11 characters Max 11 characters	Yes	0-9, hyphen Regex=@"^[0-8]\d{2}-\d{2}-\d{4}$
DateOfBirth	String	Min 10 characters Max 10 characters	Yes	0-9, hyphen, dash, period Regex=@"^(0[1-9]\|1[012])- /.- /.\d\d$
ATMPin	String	Min 4 characters Max 4 characters	Yes	0-9 Regex=@"^[0-9]{4}$
PhoneNumber	String	Min 13 characters Max 14 characters	Yes	0-9, hyphen, space, (,) Regex=@"^([2-9]\d{2}) ?\d{3}-\d{4}$
EmailAddress	String	Min 6 characters Max 50 characters	Yes	a-Z, A-Z, 0-9, underscore, hyphen, period, ampersand Regex=@"^[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)@[a-zA-Z0-9-]{2,}(.[a-zA-Z0-9-]+).([a-zA-Z]{2,4})$