postbackURL (Optional/ Preferred Method)

PostbackURL is an optional input value defined in the api/verify request. The URL specified in this field will be called back when the request is completed and reaches a terminal state (COMPLETED or EXPIRED or FAILED). The postbackURL has to support HTTP POST requests and the data will be sent based on what was configured in the channelResponse. The postbackurl should be reachable from the public internet, or from our HID server ip address as long as they have been allowed in.

Parameter Name	Type	Description
postbackURL optional/preferred	string	If this field is populated with an HTTPS URL call, HID will provide transaction details using a postback as soon as the transaction is complete. The postbackURL will get data from transactionDetails and return the data to the (Merchant). This is a Merchant-provided URL, you will have to write a service in order to be ready to receive and parse this JSON. The postback contains the same data that's in the "Status API” Response: (https://cfwebt.{{HOSTNAME}}/api/status).

Parameter Name

Type

Description

postbackURL

optional/preferred

string

If this field is populated with an HTTPS URL call, HID will provide transaction details using a postback as soon as the transaction is complete. The postbackURL will get data from transactionDetails and return the data to the (Merchant).

This is a Merchant-provided URL, you will have to write a service in order to be ready to receive and parse this JSON.

The postback contains the same data that's in the "Status API” Response: (https://cfwebt.{{HOSTNAME}}/api/status).

Sample Response

Copy

{
    "requestID":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "requestStatus":"SUCCESS",
    "uid":"998888xxxx",
    "transactions":[
              {
                 "transactionID":"xxxxxxxxxxxxxxxx",
                 "transactionStatus":"COMPLETED",
                 "transactionSubStatus":"COMPLETED",
                 "sequenceNumber":0,
                 "statusColor":"color:#FFFFFF;background:#008000;",
                 "segmentName":"ID Verified",
                 "actionCodes":{
                        "code":99.0,
                        "actionMessage":"No rescan action suggested. Default Action Code",
                        "cat":"Environment"
                 },
                "pii":{
                      "addressCity":"XXXXX",
                      "addressPostalCode":"XXXXX",
                      "addressState":"CA",
                      "addressStreet1":"XXXXX",
                      "dateOfBirth":"XXXXX",
                      "gender":"M",
                      "idExpirationDate":"XXXXX",
                      "idIssuedDate":"XXXXX",
                      "idNumber":"XXXXX",
                      "imageFront":"/9j/4AAQSkZJRgABAQAAAQABAAD/...",
                      "imageSelfie":"/9j/4AAQSkZJRgABAQAAAQABAAD/...",
                      "nameFirstname":"XXXXX",
                      "nameFullname":"XXXXX XXXXX",
                      "nameLastname":"XXXXX",
                      "selfieMatchscore":"96.64827585220337",
                      "documentName":"Drivers License",
                      "documentIssuerName":"California",
                      "documentIssuerCode":"CA",
                      "documentClassName":"Drivers License"
              },
              "passIDEThreshold":[],
              "failIDEThreshold":[],
              "uncertainIDEThreshold":[]
           }    
    ]
    }