Request Verification

POST {{baseUrl}}/bglid/recipients?demo={{demo}}&jurisdiction={{jurisdiction}}

Main request object

Key	Mandatory	Datatype	Constraints/Comments	Example
firmName	No	String	Used to present information to the client in the UI; also used in email templates and reports. If not present, the integrationName request parameter will be used instead.	“ABC accounting PTY LTD”
checkType	Yes	String (Enum) Current supported values: GOVERNMENTIDCHECK, GOVERNMENTIDADVANCEDCHECK, PEPCHECK, PEPMEDIACHECK	The check type to perform
emailAddress	Yes	String	Client’s email address	“aaron.jones@example.com”
personalDetails	Yes	PersonalDetails object (see below)	Client personal details - name, address, birth details	(See below)
sendRequestEmail	Yes	Boolean (true/false)	if true, BGLiD will send on the client’s behalf an email to their client with a direct link to the BGLiD UI. if false, BGLiD won’t send an email - it is then assumed the client will be responsible for inviting their client to use the BGLiD UI to complete the process.
numberOfIdSources	Yes	Integer	How many ID sources the client’s client is required to provide. AU - supports 1-2. NZ/SG - currently support only 1.

PersonalDetails object

Key	Mandatory	Datatype	Constraints/Comments	Example
fullName	Yes	String	Used mainly in email correspondence, UI, reports	“Jonnie Goodboy Tyler”
firstName	No	String	Allows quick prefilling of client data in the UI	“Jonnie”
middleName	No	String	Allows quick prefilling of client data in the UI	“Goodboy”
lastName	No	String	Allows quick prefilling of client data in the UI	“Tyler”
addressCountryAlpha3Code	Yes	String	Alpha 3 country code A list can be found here:	“AUS” ”SGP”
address	Yes	String		“31/12 some street, Melbourne VIC 3100”
birthCountry	No	String	Allows quick prefilling of client data in the UI	“Australia”
birthDate	No	String	Allows quick prefilling of client data in the UI ISO date format “yyyy-MM-dd”	“1980-02-15”
birthPlace	No	String	Allows quick prefilling of client data in the UI	“Melbourne”

Response Body

Key	Datatype	Constraints/Comments	Example
recipientId	Integer	Recipient ID in the BGLiD DB. Used to uniquely identify each recipient; used also in the following requests.	3112312
expiryDate	String	Last date the client’s client will be able to use the link to login into BGLiD and verify their identity. Currently set to be 21 days from the recipient-creation-date.	“2024-02-30”
verificationUrl	String	Unique URL per recipient allowing the recipients to login into BGLiD’s UI and verify themselves. This link should be kept private and shared only with the client’s client.	“http://localhost/verify-identity?r=qWmYwDRdFjkz3qOAyEriXQFeYSkrneDRyQ6BlAGzfGQ=&t=986091c2-7041-4fd2-a85f-3bdd93ca8b3f”

Request Params

Key	Datatype	Description
`demo`	string	If true, will use the demo-environment of our provider to test against (Airtable
If false will perform a production flow.
Note: Each Production request costs money
`jurisdiction`	string	Which jurisdiction (country) the client should verify against;

Allowed values: "AUSTRALIA" / "NEW_ZEALAND" / "SINGAPORE",

Each jurisdiction allows specific checks only and the checks run against that country’s government databases (if applicable).

For example - Passing an Australian client to Singapore will allow the client to only check an NRIC (an SG ID) which is incorrect; Passing an SG client to Australia will allow the client to only validate a passport vs. the AU DB (might not exist) or an AU drivers licence (which they might not have) |

Request Body

{"firmName"=>"ABC accounting PTY LTD", "checkType"=>"GOVERNMENT_ID_CHECK", "emailAddress"=>"aaron.jones@example.com", "numberOfIdSources"=>2, "personalDetails"=>{"fullName"=>"Aaron Jones", "addressCountryAlpha3Code"=>"AUS", "address"=>"606-608 Hawthorn Rd, Brighton East VIC 3187", "firstName"=>"Aaron", "birthCountry"=>"FRANCE", "birthDate"=>"1960-10-22"}, "sendRequestEmail"=>true}

HEADERS

Key	Datatype	Required	Description
`Authorization`	string
`Content-Type`	string

RESPONSES

status: Created

{&quot;expiryDate&quot;:&quot;2024-02-21&quot;,&quot;recipientId&quot;:1362,&quot;verificationUrl&quot;:&quot;https://uat.bgl-id.com/verify-identity?r=prapaYDhoTyLYLVyt%2Bf4763AXfVlDb%2FbOAl7dCJTGMI%3D\u0026t=2a6bd783-8963-49a8-a50a-6263c4ffc03b&quot;}