Pageup Technical Integration Guide – Certn

The PageUp background check API enables the CertnCentric platform to integrate directly with PageUp. This API enables:

The CertnCentric platform to poll the PageUp end points for new unprocessed background check requests every 1 minute.
The CertnCentric platform to update the status of those requests to reflect the progress of the background check.

To understand more about the standard user experience workflow that is supported by PageUp, please refer to the “Background Check API Workflow” guide published by the PageUp team.

This article is for a client technical team to understand which fields are mapped from the PageUp platform to the CertnCentric platform.

Order Field Mapping

The following fields are mapped from PageUp to CertnCentric to enable order creation in CertnCentric when triggered from the PageUp platform.


PageUp Order Fields	CertnCentric Order Fields	Description
backgroundcheckrequest/applicant/firstName	First Name	This represents the applicant’s first name. This field is optional. The legal name is taken from the applicant.
backgroundcheckrequest/applicant/middleName	Middle Name	This represents the applicant’s middle name. This field is optional. The legal name is taken from the applicant.
backgroundcheckrequest/applicant/lastName	Last Name	This represents the applicant’s Last name. This field is optional. The legal name is taken from the applicant.
backgroundcheckrequest/applicant/emailid	Email ID	This represents the applicant’s email ID. This field is mandatory.
backgroundcheckrequest/application/job/divisioncode	GroupID	This represents the Group ID in CertnCentric. This field is optional. If the Group ID is not passed, the system will associate the default Group ID setup as part of the integration.
backgroundcheckrequest/id*	PageUpID (new field)	This represents the unique PageUp ID which is associated with the order. This field is mandatory.
backgroundcheckrequest/package/code	ATS Package ID	This represents the unique Package ID which is associated with the order. This field is mandatory.
backgroundcheckrequest/application/job/positiontitle	Position Title	This represents the position title of the job. This field is mandatory. For Nationally Coordinated Criminal History Checks (NCCHC) checks, the position title setup in PageUp will be taken for the below NCCHC categories - Employment - Commonwealth For the below NCCHC categories Please make sure you setup the field values mentioned below in the ATS packages - Licence - Field Name - Licence Type - Probity (Volunteer) - Field Name - Reason for Check
backgroundcheckrequest/costCentreNumber	Tags	This represents the cost centre of the job. This field is optional. This value will be associated with the order. This value can be seen on the invoice usage report.
backgroundcheckrequest/requester / email	Client emailID	This represents the client Email ID who is triggering the order. This field is mandatory. This Email ID should be setup in CertnCentric.

Status Field Mapping

The following fields are mapped from PageUp’s background check status updates to CertnCentric, enabling order status updates to be sent from CertnCentric back to PageUp.


PageUp Order Fields	CertnCentric Order Fields	Description
backgroundcheckupdaterequest/status	Case Status	This represents the status of the overall background check request.
backgroundcheckupdaterequest/referenceNumber	CaseID	This represents the unique ID of the background check request in the CertnCentric platform
reasonForFail	Error message	In case the CertnCentric platform encounters any error during any stage of the check, this field will have the details of the error.
results	Refer to “Result Field Mapping” Section

Result Field Mapping

The following fields are mapped from PageUp’s background check status update fields to CertnCentric to enable updates to specific check results and statuses as each check is completed.


PageUp Order Fields	CertnCentric Order Fields	Description
backgroundcheckupdaterequest/status	Case Status	This represents the status of the overall background check request.
backgroundcheckupdaterequest/referenceNumber	CaseID	This represents the unique ID of the background check request in the CertnCentric platform
backgroundcheckupdaterequest/reasonForFail	Error message	In case the CertnCentric platform encounters any error during any stage of the check, this field will have the details of the error.
backgroundcheckupdaterequest/results/reportlink	Secure case report link	This represents the secure client portal URL from the CertnCentric platform. Users can log in to the platform to download the results of the specific case ID.
backgroundcheckupdaterequest/reportType	Check Type name	This represents the name of the completed check which was ordered as part of the background check request in the CertnCentric platform
backgroundcheckupdaterequest/status	Check Score/ Sub score	This represents the check score of the completed check which was ordered as part of the background check request in the CertnCentric platform.

Error Scenarios

The below are the possible error messages the CertnCentric platform will return:

Required Field is missing - When any required field is missing, the system returns the below error message and marks the status as “failed” - “The value for the below required fields are missing -
- ”
Field Format is not correct- When the format of a field is incorrect, the system returns the below error message and marks the status as “failed” - “The format of the below fields are incorrect -
format should be
- format should be ”
Invalid Group ID value- When the Group ID does not exist in CertnCentric for the specific client, the system returns the below error message and marks the status as “failed” - “The Group ID - does not exist for this organization.”
User does not belong to the group - When the user does not belong to the Group ID in the specific client , the system returns the below error message and marks the status as “failed” - “The client user whose Email ID is - does not belong to the group id - .”
Invalid Package ID value - When the Package ID does not exist in CertnCentric for the specific client, the system returns the below error message and marks the status as “failed” - “The package ID - does not exist for this organization.”
Client Email ID does not exist in the CertnCentric platform - When the Email ID does not exist in CertnCentric for the specific client, the system returns the below error message and marks the status as “failed” - “The client user whose Email ID is does not exist for this organization.”