API Overview – GBG IDscan Documentation

API Overview

For best practise of a customer journey via Idscan API, GBG would recommend to follow the below steps.

UK

Production https://prod.idscan.cloud/IDScanApp/#/login

POC/Snadbox https://poc.idscan.cloud/IDScanApp/#/login

APAC

Production https://prodoz.idscan.cloud/idscanapp/#/login

POC/Sandbox https://sydney.idscan.cloud/idscanapp/#/login

If you are unsure which endpoint you should be using please contact you Professional Services Consultant.

Step 1: Token Authentication

Use this method to generate a token that you pass within the API request when submitting images for security best practise.

Step 1.1: Retrieve JourneyDefinitionID

Use this method to return GBG’s unique GUID to ensure your API is pointing to the correct customer journey.

Step 2: Upload ID

Use this method to pass through ID documents (front and back) plus proof of address documents.

Step 2.1: Selfie

Use this method to pass  through selfie images

Step 3: Retrieval

Use this method to return the local values (international name characters) from the API response

Step 4: PDF

Use this method to export GBG results into PDF format and store internally

Step 5: Delete

Use this method to remove PII data from GBG’s audit


Was this page helpful?