Field Reference

Webhooks

2min

You can use webhooks to receive updates on the orders associated with you domain as they pass through the verification process. The url below is an example of a order webhook.
http://example.com/bluecheck?secret=yoursecret&orderID=12345&orderToken=LN1ozmffDgsI7hz3&status=approved
Order Properties
Property
Description
secret
A merchant supplied (or randomly generated) static string consisting of atleast 8 characters.
orderToken
The is the BlueCheck verification token that can be used to uniquely identify this order verification in our system. Since this is a continuation of an order that was already saved in our system the orderToken is used to associate this verification with that order. You will also need to ensure that your user verification request made to BlueCheck has this parameter included.
orderID
If you supplied an orderID value when the verification was requested, it will be returned back to you here.
status
Either "approved" or "failed".
reason
Provides additional information if applicable, such as underage or prohibited.
other
Other custom parameters can be added to the request to serve your application. To add such parameters please contact BlueCheck account management for assistance.
The following table outlines the GET data variables that can be sent to your endpoint via webhook.
Actions
The webhooks you set can up can be triggered by different changes in the order status, just like email and sms notifications. You can see a list of these events on the Notification Event Types page.

﻿

Updated 07 Sep 2023

Did this page help you?

Installing BlueCheck on Lightspeed Retail

Notification Event Types

Docs powered by Archbee

TABLE OF CONTENTS

Order Properties

Actions

Property	Description
secret	A merchant supplied (or randomly generated) static string consisting of atleast 8 characters.
orderToken	The is the BlueCheck verification token that can be used to uniquely identify this order verification in our system. Since this is a continuation of an order that was already saved in our system the orderToken is used to associate this verification with that order. You will also need to ensure that your user verification request made to BlueCheck has this parameter included.
orderID	If you supplied an orderID value when the verification was requested, it will be returned back to you here.
status	Either "approved" or "failed".
reason	Provides additional information if applicable, such as underage or prohibited.
other	Other custom parameters can be added to the request to serve your application. To add such parameters please contact BlueCheck account management for assistance.