GPS-Based Address Verification Report

GPS-Based Address Verification reports allow you to verify applicants' address using their physical location at the time of verification. The feature is only available for KYC Screenings (Regular Flow or Address screenings from Split Flow), and requires Geolocation service to be activated.

GPS-Based Address Verification works by comparing the geo-coordinates of the Applicant's residential address with the geo-coordinates of the device location retrieved during the verification process. If the two coordinates are within your acceptable range from each other, the verification is successful and a PDF file of the verification results is generated.

Getting Started

To activate the feature, follow these steps:

1. Head over to your Verification Settings inside your GlobalPass account.
2. Check whether Geolocation Verification setting is active for your account. If it is not activated, discuss enabling the feature with your account manager.
3. Head over to Address Verification Settings below, and turn on Generate GPS-Based Address Verification Reports setting.
4. Once turned on, insert the maximum allowed distance in meters between the Address and Device in the field that appears nearby.
5. Save changes. The feature is now activated.

NOTE

An Admin or Settings Manager role is required to edit the settings.

Retrieving the Report

Once the feature is activated, the verification reports will be generarated automatically by the GlobalPass system. A report is generated only in cases of successful GPS-Address verification. The conditions are as follows:

1. The steps in listed in Getting Started section above are completed.
2. Screening type is Regular KYC or Split Flow - Address.
3. Applicant has consented to providing access to device location during the verification process.
4. The straight-line distance between the coordinates of the submitted address and device location are within the range provided in the verification settings.
5. Screening is Accepted.

The GPS-Based Address report generation triggers after the screening gets Accepted, therefore, it would be ready a few seconds later than the screening is completed.

When the GPS-Address Report is ready, you will get notified via a webhook notification:

Example webhook

{
  "type": "screening.gps-address-report.completed",
  "data": {
    "screeningToken": "abb2a689-dbaa-4fb5-b185-142093f91b34",
    "reportId": "90d94f22-e5e7-465d-ba22-d7537a464498"
  }
}

Retrieving latest report

IMPORTANT

Please note that API V3 version is used for GPS-Based Address Verification Reports

To retrieve the latest available report, make an HTTP GET request to:

api/v3/gps-address/{screeningToken}/report

Retrieving reports history

To get history of all past reports, make an HTTP GET request to:

/api/v3/gps-address/{screeningToken}/report/history

Response will contain report IDs and timestamps of all previously generated reports.

Retrieving a specific historic report

To request a specific report, make an HTTP GET request by specifying both the screening token and report ID to:

/api/v3/gps-address/{screeningToken}/report/{reportId}

Trigger report generation

In case there is a need, it is possible to trigger generation of a new GPS-Based Address Verification report. To do so, make an HTTP POST request to:

/api/v3/gps-address/{screeningToken}/report

When the report is ready (given the conditions of successful generation are passed), a webhook notification will inform when it is ready to retrieve.

Retrieving Calculated Distance

The endpoint to retrieve screening details contains the calculated distance between address and device.

If you use Regular flow, make an HTTP GET call to:

/api/v3/screenings/{screeningToken}

If you use Split flow, make an HTTP GET call to:

/api/v3/screenings/address/{screeningToken}

Example response

{
  "gpsAddressData": {
    "isGpsAddressVerificationEnabled": true,
    "maxAllowedDistanceInMeters": 5000,
    "calculatedDistanceInMeters": 68476
  }
}