GIDX: CustomerIdentity

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

API Integration: CustomerIdentity

Introduction & Document Overview

This is a documentation for the CustomerIdentity 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 CustomerIdentity API Method Reference

Below are descriptions of the methods exposed by the GIDX Platform CustomerIdentity 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/CustomerIdentity
https://api.gidx-service.in/v3.0/api/CustomerIdentity
https://api.gidx-service.in/v3.0/api/CustomerIdentity

CustomerIdentity: Request & Response Parameter Constants

The following parameters are used in every CustomerIdentity 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
DeviceIpAddress
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 Required
See DeviceGPS object for more information.

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
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123_xyz
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/CustomerIdentity
https://api.gidx-service.in/v3.0/api/CustomerIdentity

Identity: CustomerRegistration

This method should be called to register the customer within the GIDX system and find verify a match to their identity.

Request Type:
HTTP POST: JSON
Parameters:
CustomerRegistrationRequest (object)
Return Value:
CustomerRegistrationResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity/CustomerRegistration

CustomerRegistrationRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123
Salutation
String
Customer Salutation
(Dr., Mr., Mrs., etc.)
FirstName
String Required
Customer First Name
John
MiddleName
String
Customer Middle Name
Michael
LastName
String Required
Customer Last Name
Doe
Suffix
String
Customer Name Suffix
(Sr., Jr., etc.)
FullName
String
Customer Full Name (if separate name parts are not available.
Dr. John Michael Doe Jr.
DateOfBirth
Date Required
Date of birth of customer.
04/03/1984 (In MM/DD/YYYY Format)
EmailAddress
String Required
Email address of customer.
johndoe@msn.com
CitizenshipCountryCode
String Suggested
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 should be posted as the full 9 digit number. This is not a recomended data solution unless all other options have been attempted.
MobilePhoneNumber
String
Mobile Phone number for customer.
(999) 834-5813
PhoneNumber
String
Phone number for customer.
(999) 834-5814
AddressLine1
String Suggested
Customer Address Line 1
5940 Main St.
AddressLine2
String
Customer Address Line 2
Suite A
City
String Suggested
Customer City
Las Vegas
StateCode
String Suggested
See Appendix: StateCode.
NV
PostalCode
String Suggested
Customer postal code.
77587
CountryCode
String Suggested
See Appendix: ISO 2 Digit Country Code.
US
CustomerIpAddressCountryCode
String
See Appendix: ISO 2 Digit Country Code.
US
NOTE: Either the customers Date of Birth OR the Customers Address must be supplied.

CustomerRegistrationResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123
WatchChecks
Object
See the WatchCheck Object for more information.
['US-OFAC','US-FBI-HS']
ReasonCodes
Object
See ReasonCodes for more information.
['ID-VERIFIED', 'ID-EX', 'DFP-HR']
LocationDetail
Object
See the LocationDetail Object for more information.
[See Object Details]
ProfileMatch
Object
See the ProfileMatch Object for more information.
[See Object Details]
CustomerRegistrationLink
String
Customized URL for this Customers Registration. This URL can be used for further Identity verification to be done by the customer in an on demand environment.
http://www.CustomUrl.com/UniqueID
This service requires additional approval and set-up for the Merchant account and will not be returned without prior authorization for the account.
IdentityConfidenceScore
Decimal
Confidence of consistent identity data for customer.
98.5
FraudConfidenceScore
Decimal
Confidence of absence of fraud for customer.
98.5
https://api.gidx-service.in/v3.0/api/CustomerIdentity
https://api.gidx-service.in/v3.0/api/CustomerIdentity

Identity: CustomerProfile

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

Request Type:
HTTP GET: QueryString
Parameters:
CustomerProfileRequest (object)
Return Value:
CustomerProfileResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity/CustomerProfile

CustomerProfileRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123

CustomerProfileResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123
Name
Object
Array of Name object
See Object Reference
Address
Object
Array of Address object
See Object Reference
Citizenship
Object
Array of Citizenship object
See Object Reference
DateOfBirth
Object
Array of Birth object
See Object Reference
Device
Object
Array of Device object
See Object Reference
Education
Object
Array of Education object
See Object Reference
Email
Object
Array of Email object
See Object Reference
IdDocument
Object
Array of Identity Document object
See Object Reference
Job
Object
Array of Job object
See Object Reference
Phone
Object
Array of Phone object
See Object Reference
SocialMedia
Object
Array of Social Media object
See Object Reference
WatchChecks
Object
Array of string
See Object Definition
ReasonCodes
Object
Array of string
['ID-VERIFIED','ID-EX','LL-GEO-US-NV']
ProfileMatches
Object
Array of string
[“ABC_123”,“456_LMN”]
If the ReasonCode “ID-EX” is contained in the ReasonCode value then the “ProfileMatches” value will contain an Array of string values connecting the other customer accounts belonging to this person.
IdentityConfidenceScore
Decimal
The confidence that the identity data is accurate.
98.5
FraudConfidenceScore
Decimal
The confidence against identity fraud.
85.3

Identity: 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.

Request Type:
HTTP POST: JSON
Parameters:
CustomerMonitorRequest (object)
Return Value:
CustomerMonitorResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity/CustomerMonitor

CustomerMonitorRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123
ContestCodes
Array
An array of strings representing the contest information.
["NFL-HOU", "NFL-ATL"]

CustomerMonitorResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123
WatchChecks
Object
Array of string
See Object Definition
ReasonCodes
Object
Array of string
['ID-VERIFIED','ID-EX','LL-GEO-US-NV']
LocationDetail
Object
See the LocationDetail Object for more information.
[See Object Details]
IdentityConfidenceScore
Object
Decimal
98.5
FraudConfidenceScore
Object
Decimal
85.3

Identity: CustomerUpdate

This method may be called to update a customer's information without going through any verification. ID-VERIFIED and ID-BLOCK can also be added using this method.

Request Type:
HTTP POST: JSON
Parameters:
CustomerUpdateRequest (object)
Return Value:
CustomerUpdateResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity/CustomerUpdate

CustomerUpdateRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123
Verified
Boolean
Should the user have the ID-VERIFIED reason code? Use null to leave ID-VERIFIED status as is.
true, false, null
Blocked
Boolean
Should the user have the ID-BLOCK reason code? Use null to leave ID-BLOCK status as is.
true, false, null
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.)
FullName
String
Customer Full Name (if separate name parts are not available.
Dr. John Michael Doe Jr.
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
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 should be posted as the full 9 digit number. This is not a recomended data solution unless all other options have been attempted.
MobilePhoneNumber
String
Mobile Phone number for customer.
(999) 834-5813
PhoneNumber
String
Phone number for customer.
(999) 834-5814
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

CustomerUpdateResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123
ReasonCodes
Object
See ReasonCodes for more information.
['DFP-HR','ID-EX']
https://api.gidx-service.in/v3.0/api/CustomerIdentity
https://api.gidx-service.in/v3.0/api/CustomerIdentity

Identity: RemoveCustomer

This method may be called to remove a customer from your merchant account.

Request Type:
HTTP POST: JSON
Parameters:
RemoveCustomerRequest (object)
Return Value:
RemoveCustomerResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity/RemoveCustomer

RemoveCustomerRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123

RemoveCustomerResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123

Profile Notification

Receiving a Profile Notification from the GIDX Platform requires a pre-defined notification URL on a trusted merchant server.
When a customer's profile information is updated by the GIDX Platform a JSON post is sent to this notification URL containing the information shown below.

This URL must be able to accept the request (a) from the GIDX environment and provide a response in the format indicated in example (b) below. The format of the Notification Service request uses the same structure as the Callback service found in the WebReg Customer Identity service and the Web Cashier service.

Sent to the Merchant: Notification Request Object

MerchantCustomerID
String
The unique ID for this customer provided by the merchant in an earlier service.
ABC-123
NotificationType
String
The type of notification. Note: Only notification for customer profiles are currently available.
CustomerProfile


Expected from Merchant: Notification Response Object

When the merchant's service receives the Notification request the expected response from the merchant should be as follows...

Accepted
bool
true


If the response is not provided back to the GIDX service the Notification attempt will be placed back in the queue and will be retried in regular intervals up to 5 times or until an accepted response is provided back successfully.

Upon receiving this notification it is expected that the merchant will log the notification and make a call the CustomerProfile method in order to retrieve any updated/added data that has been applied to the Customers profile.

//Example Notification - Request to merchant { MerchantCustomerID: "ABC-123", NotificationType: "CustomerProfile" } //Example Notification - Response to merchant { Accepted: true }
https://api.gidx-service.in/v3.0/api/CustomerIdentity
https://api.gidx-service.in/v3.0/api/CustomerIdentity

Location: 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.

Request Type:
HTTP POST: JSON
Parameters:
LocationRequest (object)
Return Value:
LocationResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/CustomerIdentity/Location

LocationRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Suggested
Your unique ID for this customer.
ABC-123

LocationResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
LocationDetail
Object
See the LocationDetail Object for more information.
[See Object Details]

Response Object Reference

The Object documented below are returned within the Response of Method Request within the GIDX Platform CustomerIdentity 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.

Profile Object: Address

This object contains the Address data associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
Address Type
Customer Address Type.
String
Residence
AddressLine1
Customer Address Line 1.
String
5940 Main St.
AddressLine2
Customer Address Line 2.
String
Suite A
City
Customer City.
String
Las Vegas
StateCode
Customer State.
String
NV
County
Customer County.
String
Clark
PostalCode
Customer postal code.
String
89141-1097
Country
Customer Country.
String
US
Neighborhood
Customer Neighborhood details.
String
Downtown
IdentityConfidenceScore
0 – 100 Score: Confidence in this Address belonging to this person.
Decimal
98.5
Primary
Primary Address for this profile.
Boolean
TRUE

Profile Object: Birth

This object contains the full name associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
PlaceOfBirth
Place of birth.
String
Washington, US
DateOfBirth
Date of birth.
Date
(MM/DD/YYYY)
IdentityConfidenceScore
0 – 100 Score: Confidence in this Birth (Date of Birth) belonging to this person.
Decimal
98.5
Primary
Primary Birth (Date of Birth) for this person.
Boolean
TRUE

Profile Object: Citizenship

This object contains the Citizenship data associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
CountryCode
2 digit ISO code for country of citizenship.
String
(713) 834-5813
DateAcquired
Date the citizenship was acquired.
Date
30746
IdentityConfidenceScore
0 – 100 Score: Confidence in this Citizenship belonging to this person.
Decimal
98.5
Primary
Primary Citizenship for this profile.
Boolean
TRUE

Profile Object: Device

This object contains the Device data associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
DeviceID
Registration device unique identifier.
string
D05OCnpoQ6OqlsE4gdjQug
Platform
Registration device platform.
String
Windows 7
IdentityConfidenceScore
0 – 100 Score: Confidence in this Device belonging to this person.
Decimal
98.5
Primary
Primary Device for this profile.
Boolean
TRUE

Profile Object: Education

This object contains the education associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
StartDate
Starting date.
Date
2010-08-01
EndDate
Ending date.
Date
2014-05-01
School
Name of school.
String
University of Texas
Degree
Type of degree.
String
Bachelor's Degree
IdentityConfidenceScore
0 – 100 Score: Confidence in this Birth (Date of Birth) belonging to this person.
Decimal
98.5

Profile Object: Email

This object contains the Email data associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
EmailAddress
Email address of customer.
String
johndoe@msn.com
IdentityConfidenceScore
0 – 100 Score: Confidence in this Email belonging to this person.
Decimal
98.5
Primary
Primary Email for this profile.
Boolean
TRUE

Profile Object: IdentityDocument

This object contains the Identity Document data associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
IDTypeCode
Type of Identification Number provided in the IDNumber field. This is refenced as the (IdentificationTypeCode) within the CustomerRegistrationRequest.
String
1
IDNumber
The Customer's Identity # is available only with assigned compliance registration by the merchant. This is refenced as the (IdentificationNumber) within the CustomerRegistrationRequest.
String
*** ** 1234
IssuingPlace
Customer identity issuing place.
String
San Diego, CA
IssuingDate
Customer identity issuing date.
Date
07/33/1985
NameOnID
Customer name on identity card.
String
John M Doe
IdentityConfidenceScore
0 – 100 Score: Confidence in this Identity Document belonging to this person.
Decimal
98.5
Primary
Primary Identity Document for this profile.
Boolean
TRUE

Profile Object: Job

This object contains the work history associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
StartDate
Starting date.
Date
2010-08-01
EndDate
Ending date.
Date
2014-05-01
Organization
Name of organization.
String
TSEVO, LLC
Title
Title of position.
String
Software Developer
Industry
Industry.
String
Technology
IdentityConfidenceScore
0 – 100 Score: Confidence in this Birth (Date of Birth) belonging to this person.
Decimal
98.5

Profile Object: Name

This object contains the full name associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
Salutation
Customer Salutation.
String
(Dr., Mr., Mrs., etc.)
FirstName
Customer First Name.
String
John
LastName
Customer Last Name.
String
Doe
MiddleName
Customer Middle Name.
String
Michael
Suffix
Customer Name Suffix.
String
(Sr., Jr., etc.)
IdentityConfidenceScore
0 – 100 Score: Confidence in this Name belonging to this person.
Decimal
98.5
Primary
Primary Name for this person.
Boolean
TRUE

Profile Object: Phone

This object contains the Phone data associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
PhoneNumber
Customer Phone #.
String
(713) 834-5813
CountryCode
Customer Country Code.
String
1
Extension
Customer Phone Extension.
String
Carrier
Customer Phone Carrier.
String
AT&T
LineType
Customer Phone Line Type.
String
Wireless
IdentityConfidenceScore
0 – 100 Score: Confidence in this Phone belonging to this person.
Decimal
98.5
Primary
Primary Phone for this profile.
Boolean
TRUE

Profile Object: ProfileMatch

This object contains the data match status of the customer profile information passed into the CustomerRegistration Request.

Returned in Response:
CustomerRegistrationResponse
Usage:
The results contained in this object will quickly tell you which data parameters where successfully matched and which ones where not.
Property Name
Description / Data Type
Example
NameMatch
Was a match found?
Boolean
TRUE
AddressMatch
Was a match found?
Boolean
TRUE
EmailMatch
Was a match found?
Boolean
FALSE
IdDocumentMatch
Was a match found?
Boolean
TRUE
PhoneMatch
Was a match found?
Boolean
TRUE
MobilePhoneMatch
Was a match found?
Boolean
FALSE
DateOfBirthMatch
Was a match found?
Boolean
TRUE
CitizenshipMatch
Was a match found?
Boolean
TRUE

Profile Object: SocialMedia

This object contains the social media account associated with the customer's profile.

Returned in Response:
CustomerProfileResponse
Property Name
Description / Data Type
Example
UserID
User ID for the social media account.
String
100002122533075
Name
Name of social network
String
facebook, linkedin, twitter
IdentityConfidenceScore
0 – 100 Score: Confidence in this Birth (Date of Birth) belonging to this person.
Decimal
98.5

Profile Object: WatchCheck

This object contains the matching Watch List data of the customer profile.

Returned in Response:
CustomerRegistrationResponse, CustomerProfileResponse and CustomerMonitorResponse
Property Name
Description / Data Type
Example
SourceCode
Source code name of watch list that was checked. See Appendix: WatchCheck
String
US-OFAC
SourceScore
0 – 100 Score: The accuracy ranking of the source.
Decimal
98.5
MatchResult
Result of a match level on the source data.
Boolean
TRUE
MatchScore
0 – 100 Score: The completeness on the match to the source.
Decimal
98.5

Location Object: LocationDetail

This object contains the data match status of the customer profile information passed into the CustomerRegistration Request.

Returned in Response:
CustomerRegistrationResponse, CustomerMonitorResponse, and LocationResponse
Property Name
Description / Data Type
Example
Latitude
Customer latitude.
double
36.169727
Longitude
Customer longitude.
double
-115.141801
Radius
Customer approximate distance.
int
600
Altitude
The altitude of the determined location.
double
22.9871
Speed
Speed in which the customer is traveling in km / hour.
int
45
LocationDateTime
Date time of customer’s location service.
DateTime
10/01/2013 12:42:15 GMT
LocationStatus
0 Not Found, 1 In Progress, 2 Found, 3 Time out.
int
2
LocationServiceLevel
Standard is applied to the best non-opt in service accuracy available (IP Location or Device GPS).
string
Standard
ReasonCodes
Array / Object (comma delimited) set of Reason Codes for any alerts that occurred during the registration.
Array of string
['LL-BLOCK-US-NV','LL-GEO-US-NV']
ComplianceLocationStatus
This is for Advanced Location Validation Only and should be ignored when using the Standard IP / GPS based location services.
Bool
TRUE
ComplianceLocationServiceStatus
This is for Advanced Location Validation Only and should be ignored when using the Standard IP / GPS based location services.
String
Inactive

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 CustomerIdentity Services.

Appendix Library: Response Codes & Messages

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: 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: LocationType

Code
Description / Source
Auto
Use the default settings from the merchant if available.
Standard Account Approval
Statndard
Uses Advanced IP Address and/or Device GPS Data with Proxy Detection.
Advanced
Uses Carrier Level e911 Location Validation
Requires Customer Opt-In and Advanced Account Status

Appendix Library: Location Status Response

Code
Description / Source
0
Location Not Found
1
Location Detection / Verification In Progress
2
Location Found
3
Location Service Timed Out

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