Verification Screen Calls

Server Calls for Getting Verification Screens#

1. Get Auth Token#

POST {{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials

curl --location --request POST '{{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials' \
--header 'Authorization: Basic {{auth_credentials}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw ''
> ### 2. Get List of Verification Screens
> `GET {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/templates`
> ```
curl --location --request GET '{{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/templates' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw ''

2. Get a Specific Verification Screen#

GET {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}

curl --location --request GET '{{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw ''
### Server Calls for Adding a Verification Screen
> ### 1. Get Auth Token
> `POST {{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials`
> ```
curl --location --request POST '{{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials' \
--header 'Authorization: Basic {{auth_credentials}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw ''

2. Add a Verification Screen for the Tenant Application#

PUT {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}

curl --location --request PUT '{{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "{{template_code}}",
"body": "",
"type": "native",
"headerText": "{{header_text}}",
"bodyText": "{{body_text}}",
"alertBackgroundColor": "#4A4A4A",
"alertTextColor": "#4A4A4A",
"alertTextboxColor": "#FFFFFF",
"logoDisplayType": "application",
"logoUrl": "",
"backgroundImageUrl": "",
"algorithmOperation": "choice",
"required": null,
"optional": null
}'
> ### 3. Add a Biometric to the Verification Screen
> `PUT {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}/type/{{capture_type}}`
> ```
curl --location --request PUT '{{gmi_server_url}}/v2/gmiserver/tenant/iwsinternal/app/Imageware Authenticate/template/GoogleFacePalmPin/type/pin' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"sequence": 0
}'

Server Calls for Updating a Verification Screen#

1. Get Auth Token#

POST {{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials

curl --location --request POST '{{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials' \
--header 'Authorization: Basic {{auth_credentials}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw ''
> ### 2. Update a Verification Screen for the Tenant Application
> `PUT {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}`
> ```
curl --location --request PUT '{{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "{{template_code}}",
"body": "",
"type": "native",
"headerText": "{{header_text}}",
"bodyText": "{{body_text}}",
"alertBackgroundColor": "#4A4A4A",
"alertTextColor": "#4A4A4A",
"alertTextboxColor": "#FFFFFF",
"logoDisplayType": "application",
"logoUrl": "",
"backgroundImageUrl": "",
"algorithmOperation": "choice",
"required": null,
"optional": null
}'

3. Add a Biometric to the Verification Screen#

PUT {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}/type/{{capture_type}}

curl --location --request PUT '{{gmi_server_url}}/v2/gmiserver/tenant/iwsinternal/app/Imageware Authenticate/template/GoogleFacePalmPin/type/pin' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"sequence": 0

}'

> ### 3. Remove a Biometric from the Verification Screen
> `DELETE {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}/type/{{capture_type}}`
> ```
curl --location --request DELETE '{{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}/type/{{capture_type}}' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw ''

Server Calls for Deleting a Verification Screen#

1. Get Auth Token#

POST {{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials

curl --location --request POST '{{user_server_url}}/v2/oauth2/oauth/token?scope=SCOPE_TENANT_ADMIN&grant_type=client_credentials' \
--header 'Authorization: Basic {{auth_credentials}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw ''
> ### 2. Delete a Verification Screen from the Tenant Application
> `DELETE {{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}`
> ```
curl --location --request DELETE '{{gmi_server_url}}/v2/gmiserver/tenant/{{tenant_code}}/app/{{app_code}}/template/{{template_code}}' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw ''
Edit this page