GIDX: WebReg

Home / API Reference
Code Samples Coming Soon... C# PHP Python

API Integration: WebReg

Introduction & Document Overview

This is a documentation for the WebReg API, a service within the Customer Insight Solution set of the GIDX Platform.

This set of documents serves as the integration guide for implementing services of the GIDX Platform API within the operator’s environment. The following pages outline the Customer Insight access points, security, methods, and parameters. As always, please contact us at devteam@tsevo.com any time if further explanation is needed.

API libraries

An official SDK for the GIDX Platform API is available at GitHub.com and via NuGet (GIDX.SDK) located at the URL below. This SDK can be installed directly into your C# project using the NuGet Package Manager.

SDK Location
https://github.com/TSEVOLLC/GIDX.SDK-csharp

GIDX Platform WebReg API Method Reference

Below are descriptions of the methods exposed by the GIDX Platform WebReg Service. For details about the parameters associated with these methods please see the Class Reference section below.

https://api.gidx-service.in/v3.0/api/WebReg
https://api.gidx-service.in/v3.0/api/WebReg
https://api.gidx-service.in/v3.0/api/WebReg

WebReg: Request & Response Parameter Constants

The following parameters are used in every WebReg Method Request and Responses. They are labeled within the methods below as Standardized Request Parameters and Standardized Response Parameters.

Making a Request
Each API method has a corresponding Request object used to transport the request parameters as shown below.

Using the Response
Each Response object returned from the method Request will contain properties you can use to determine the status of the methods service. Use the IsSuccess property along with the ResponseCode and ResponseMessage values to detect if the Request completed without a problem.

Standardized Request Parameters

ApiKey
String Required
Your assigned ApiKey, provided to you by the GIDX team.
4QhgWWJxRlqVctrc7SxHEQ
MerchantID
String Required
Your assigned Merchant ID, provided to you by the GIDX team.
VpGYLoXhSS+WgU9N415IJQ
ProductTypeID
String Required
Your assigned ID for merchant product type.
Fc+k5kRDSAOrh38e21vt0w
DeviceTypeID
String Required
Your assigned ID for this specific customer device type.
m+2XHlcIR0O1C+iBeNzfvA
ActivityTypeID
String Required
Your assigned ID for this specific customer activity type.
VV4XTc3tRi6g1EYLOazn0g
MerchantSessionID
String Required
A unique SessionID from your system assigned to this active session.
xHhSS+WglqVctrc7-t7SEQrc

Standardized Response Parameters

ApiKey
String Echo
Echo of your assigned ApiKey that you provided in the request.
4QhgWWJxRlqVctrc7SxHEQ
MerchantID
String Echo
Echo of your assigned Merchant ID that you provided in the request.
VpGYLoXhSS+WgU9N415IJQ
MerchantSessionID
String Echo
Echo of your unique SessionID for this active session that you provided in the request.
xHhSS+WglqVctrc7-t7SEQrc
ResponseCode
Integer
Response code for the method call. This will be 0 if there are no issues, non-zero otherwise.
0
ResponseMessage
String
Readable text message corresponding to the response code.
No Errors
https://api.gidx-service.in/v3.0/api/WebReg
https://api.gidx-service.in/v3.0/api/WebReg

Identity: CreateSession

This method should be called to create a customer identity verification Web Session within the GIDX system and verify identity of the customer.

Request Type:
HTTP POST: JSON Content Body
Parameters:
CreateSessionWebRegRequest (object)
Return Value:
CreateSessionWebRegResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/WebReg/CreateSession

CreateSessionWebRegRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123
CustomerIpAddress
String Required
IP address for the current device (The Customers' Device – NOT your servers IP address) for this active session.
66.249.76.138
DeviceGPS
Object
See DeviceGPS object for more information.
FullName
String
Customer Full Name (if separate name parts are not available.
Dr. John Michael Doe Jr.
Salutation
String
Customer Salutation
(Dr., Mr., Mrs., etc.)
FirstName
String
Customer First Name
John
MiddleName
String
Customer Middle Name
Michael
LastName
String
Customer Last Name
Doe
Suffix
String
Customer Name Suffix
(Sr., Jr., etc.)
DateOfBirth
Date
Date of birth of customer.
04/03/1984 (In MM/DD/YYYY Format)
EmailAddress
String
Email address of customer.
johndoe@msn.com
CitizenshipCountryCode
String
See Appendix: ISO 2 Digit Country Code.
US
NOTE: If your account settings allow for international customer identity verification then you must supply the ISO 2 Digit Country Code as the CitizenshipCountryCode value. A null string will default to US.
IdentificationTypeCode
String
See Appendix: IdentificationTypeCode.
1
IdentificationNumber
String
Identification number for customer.
444-12-1234
NOTE: If the IdentificationTypeCode is set as 1 (US SSN) then the IdentificationNumber can be posted as the full 9 digits or the last 4 digits of the number.
MobilePhoneNumber
String
Mobile Phone number for customer.
(999) 834-5813
AddressLine1
String
Customer Address Line 1
5940 Main St.
AddressLine2
String
Customer Address Line 2
Suite A
City
String
Customer City
Las Vegas
StateCode
String
See Appendix: StateCode.
NV
PostalCode
String
Customer postal code.
77587
CountryCode
String
See Appendix: ISO 2 Digit Country Code.
US
CallbackURL
String Required
https://yourserver.com/GidxCallback
Once the customer registration is complete, the customer registration timeouts, or the customer is blocked from completing the registration due to incomplete or incorrect answers, the GIDX system will call the CallbackURL that you provide here to notify your system of the status of the registration session.

CreateSessionWebRegResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
ReasonCodes
Object
See ReasonCodes for more information.
['DFP-HR','ID-EX']
SessionID
String
Unique ID in the GIDX system for the registration session.
xHhSS+WglqVctrc7-t7SEQrc
SessionURL
String
Script tag to be included in the html body of Merchant Customer Identity Verification page.
See Example
SessionExpirationTime
DateTime
Time at which the session URL will expire if not loaded on the customer web page before then.
5/30/2017 4:57:06

RegistrationCallback

Receiving callbacks from a GIDX Web Session service to your registered callback URL for the CreateSession Method.
Once the customer's session with the GIDX Web Registration service is complete a callback will be made to the registered callback URL for you. The callback will consist of a HTML form post with one field named "result" which contains the JSON status of the customer's session. An examples of the returned JSON within a Callback is on the right side of this page.

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
StatusCode
Integer
Status code for the method call. This will be 0 if there are no issues, non-zero otherwise.
0
StatusMessage
String
Readable text message corresponding to the status code.
No Errors
MerchantSessionID
String Echo
Echo of your unique SessionID for this active session that you provided in the request.
xHhSS+WglqVctrc7-t7SEQrc
ReasonCodes
Object
See ReasonCodes for more information.
['DFP-HR','ID-EX']
SessionID
String
Unique ID in the GIDX system for the registration session.
xHhSS+WglqVctrc7-t7SEQrc
SessionScore
Decimal
Validation Score based on the Session Data Confidence.
98.5
ServiceType
String
Status Type of the Session
See Index
//Example Request [{ "ApiKey": "4QhgWWJxRlqVctrc7SxHEQ", "MerchantID": "VpGYLoXhSS+WgU9N415IJQ", "ProductTypeID": "Fc+k5kRDSAOrh38e21vt0w", "DeviceTypeID": "m+2XHlcIR0O1C+iBeNzfvA", "ActivityTypeID": "VV4XTc3tRi6g1EYLOazn0g", "MerchantSessionID": "123_ID_GOES_HERE", "CustomerIpAddress": "66.249.76.138", "MerchantCustomerID": "J39JU43s1U9996A1B2aTg", "CallbackURL": "http://callbacks.merchantdomain.com/CallbackStatus", "FirstName": "John", "LastName": "Smith", "DateOfBirth": "05/22/1981", "EmailAddress": "johnsmith@domain.net", "CitizenshipCountryCode": "US", "AddressLine1": "1234 Main St", "AddressLine2": "", "City": "Houston", "StateCode": "TX", "PostalCode": "77002", "CountryCode": "US" }] //Example Response { "ApiKey": "4QhgWWJxRlqVctrc7SxHEQ", "ApiVersion": 3.0, "MerchantID": "VpGYLoXhSS+WgU9N415IJQ", "MerchantSessionID": "123_ID_GOES_HERE", "ResponseCode": 0, "ResponseMessage": "No error.", "SessionID": "X9XeW5FvCEKimOKw59GNPA", "SessionURL": "%3cdiv+data-gidx-script-loading%3d%27true%27%3eLoading...%3c%2fdiv%3e%3cscript+src%3d%27http%3a%2f%2fapi.gidx.com%2fgidx.WebSession%2fWebSession%2fWebReg%3fsessionid%3dX9XeW5FvCEKimOKw59GNPA%27+data-tsevo-script-tag+data-gidx-session-id%3d%27X9XeW5FvCEKimOKw59GNPA%27+type%3d%27text%2fjavascript%27%3e%3c%2fscript%3e", "SessionExpirationTime": "2014-11-13T17:40:16.1853074Z", "ReasonCodes": ["LL-GEO-US-TX"] } //Example Callback { "StatusCode": 0, "StatusMessage": "Registration is complete. Please call CustomerRegistration method to get registration details.", "SessionID": "X9XeW5FvCEKimOKw59GNPA", "MerchantSessionID": "123_ID_GOES_HERE", "SessionScore": 96.2, "ReasonCodes": ["ID-VERIFIED","LL-GEO-US-TX","DFP-VPRP-CORP"], "ServiceType": "Customer Registration" }
https://api.gidx-service.in/v3.0/api/WebReg
https://api.gidx-service.in/v3.0/api/WebReg

Identity: RegistrationStatus

This method may be called at any time by the merchant to retrieve the status of the customer registration process based on the merchant's unique session id provided in the CreateSession method call.

Request Type:
HTTP GET: QueryString
Parameters:
RegistrationStatusRequest (object)
Return Value:
RegistrationStatusResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/WebReg/RegistrationStatus

RegistrationStatusRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantSessionID
String Required
The SessionID for the CreateSession call that you are requesting status on.
xHhSS+WglqVctrc7-t7SEQrc

RegistrationStatusResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
ReasonCodes
Object
Array of string
[“LL-GEO-US-NV”,“ID-VERIFIED”,“ID-EX”]
RegistrationStatusCode
String
See Status Codes & Status Message.
RegistrationStatusMessage
String
Status message corresponding to the status code above.

CustomerIdentity API Methods

The other Identity & Location Methods are located in the CustomerIdentity API located at the endpoint below.

Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity

You can view the details of these additional Customer Identity related methods by clicking on the links below.

  • CustomerProfile
    This method may be called to get the profile information associated with a verified MerchantCustomerID within the GIDX system.

  • CustomerMonitor
    This method may be called to get the current compliance status of the customer profile associated with a verified MerchantCustomerID within the GIDX system.

  • Location
    Location look-up is based on the IP address / Device GPS and the Merchant Settings. Although a MerchantCustomerID is not required it is suggested that any method calls for location associated with a registered customer should have a MerchantCustomerID provided for tracking and compliance audit purposes. The response contains the location details based on the Merchants settings.

  • Profile Notification
    This is similar to the accepting code needed for the Callback functions associated with Web Session Services. When a customers profile is updated with new data a formated JSON message is sent to the merchants pre-defined URL to notify them of the updates. This service requires a pre-defined Notification URL provided by the merchant.

Response Object Reference

The Object documented below are returned within the Response of Method Request within the GIDX Platform WebReg Services. When applicable an Object may be shared by among other Method Responses as indicated in the listings below.

Objects are always returned in JSON format.

Location Object: DeviceGPS

This object should contain the location data derived from the Devices GPS information.

For more information on collecting this data from the Device please click here   to see the table below for both iOS and Android.

Apple / iOS

Device GPS Property Class Property Declaration
Latitude & LongitudeCLLocationcoordinateCLLocationCoordinate2D
latitudeCLLLocationDegrees
longitudeCLLLocationDegrees
RadiusCLLocationhorizontalAccuracyCLLocationAccuracy
AltitudeCLLocationaltitudeCLLocationDistance
SpeedCLLocationspeedCLLocationSpeed
DateTimeCLLocationtimestampNSDate

Android

Device GPS Property Class Property
LatitudeLocationgetLatitude()
LongitudeLocationgetLongitude()
RadiusLocationgetAccuracy()
AltitudeLocationgetAltitude()
SpeedLocationgetSpeed()
DateTimeLocationgetTime()
  The DateTime in Android is a "ticks" and needs to be converted to the dateTime format MM/DD/YYYY HH:MM:SS.000
Property Name
Description / Data Type
Example
Latitude
Customer latitude.
double
36.169727
Longitude
Customer longitude.
double
-115.141801
Radius
Customer approximate distance.
double
600.999
Altitude
The altitude of the determined location.
double
22.9871
Speed
Speed in which the customer is traveling in km / hour.
double
45.999
DateTime
Date time of customer’s location service.
DateTime
10/01/2013 12:42:15 GMT

Appendix Library: Code / Status Index

The information documented below provides clarification of the codes used within the GIDX Platform WebReg Services.

Appendix Library: ResponseCodes & ResponseMessage

Code
Message / Description
0
Good - Successful Response
500
General Error - Unknown Response Error
501
Invalid Request - Incorrect Request Format or Access Status
502
Unauthorized Request - Security Block of Request

Appendix Library: Session StatusCode

Code
Message / Description
0
Complete
The process is complete and has met all eligibility requirements.
1
Ineligible
The customer did not supply information that could be successfully validated.
2
Incomplete
Customer stopped during the process and marked as Incomplete.
3
Timeout
The customer exceeded their maximum allowed time to complete for the process.
4
In Progress (plus step number)
This returns the latest 'step' in the process that the customer has completed.

Appendix Library: IdentificationTypeCode

Code
Description / Source
1
U.S. Assigned Social Security Number
2
Assigned Drivers License Number
3
Global Passport Document
4-CC
National Identity Card - PLUS the 2 Digit ISO Country Code
999+
Custom Merchant Specific Document
Requires Advanced Account Status

Appendix Library: Data & System Reference

ISO 2 Digit Country Code

ISO 3166-1 is part of the ISO 3166 standard published by the International Organization for Standardization (ISO), and defines codes for the names of countries, dependent territories, and special areas of geographical interest.
http://en.wikipedia.org/wiki/ISO_3166-1

ISO 2 Digit U.S. State Codes

ISO 3166-2:US is the entry for the United States in ISO 3166-2, part of the ISO 3166 standard published by the International Organization for Standardization (ISO), which defines codes for the names of the principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.
http://en.wikipedia.org/wiki/ISO_3166-2:US

ReasonCodes

For the latest list of Reason Codes and their description please go to the following URL.
View Reason Codes