Application parameters
Certn API parameters for how to request checks, collect information and generate reports.
This article lists all the parameters available when making PUT
or POST
calls to the /applicants
endpoints.
Invite an applicant
Provide the applicant's email address, along with the appropriate Request flags. All other parameters are optional.
Run a quick screen
Provide the required parameters for each of your checks, along with the appropriate Request flags. Find the required parameters for specific checks in their page under Run a check.
An asterisk (*) next to a parameter name indicates that it's a required parameter within that object. The API will throw an error if the object is present but the parameter is missing.
Main parameters
Parameter objects
Address
Address Reference
Base Address
Conviction
Credential
Degree
Education
Education verification notes
Employer
Employer verification notes
Employer References
Email
Enhanced Identity Verification
Information
Name
Phone Number
Position or Property Location
The parameters to use for position_or_property_location
will depend on your location_type
.
If you're in the Gig economy and the position you're hiring for won't be tied to a single location, use this parameter:
For any other industries, use these ones:
Purpose of check (Basic Disclosure And Barring Service Check)
Social Media Details
Specialization
Last updated