Backend - Integration API Functions¶

This section describes the functions that need to be implemented in the EnQualify Integration API.

📌 Important: The following API functions should be implemented alongside the methods provided by Integration Services. EnQualify calls these methods when necessary — not the other way around.

Integration/IDCheck — Identity Information Inquiry¶

If the caller's identity information has not been sent with Integration/Add or cannot be found in the system, EnQualify will request the identity information from Integration Services using the Integration/IDCheck method.

Expected Request¶

Parameter	Description
`Reference`	Reference Id sent in `Integration/Add`.
`IdentityType`	The identity type of the caller.
`IdentityNo`	The identity number of the caller.

Expected Response¶

Parameter	Description
`IDRegistration`	Identity registration data.
`AddressRegistration`	Address data.

Integration/Form — Obtain Custom Form URL¶

If a custom form URL is not provided in Integration/Add, EnQualify requests this URL from Integration Services using the Integration/Form method.

Expected Request¶

Parameter	Description
`Reference`	Reference Id sent in `Integration/Add`.
`SessionUId`	The Id of the call in EnQualify.
`IntegrationUId`	The Id of the integration data in EnQualify.

Expected Response¶

Parameter	Description
`FormUrl`	The URL to be used for the form.

Integration/Send — Completed Call Notification¶

When a call is completed, EnQualify notifies Integration Services using the Integration/Send method. After receiving the notification, Integration Services can request the call data using the Session/Get Web API method.

Expected Request¶

Parameter	Description
`Reference`	Reference Id sent in `Integration/Add`.
`SessionUId`	The Id of the call in EnQualify.
`Reason`	The call result code assigned by the admin.
`ReasonDetail`	Description entered for the call result.
`TaxNumber`	Tax number sent in the KYB flow.
`NotifyType`	The event type that triggered the notification. Takes one of the following values:

NotifyType Values:

Parameter	Description
`AgentRatingWithReference` (`0`)	When an agent rating is made. Ratings without a reference are not sent to `Integration/Send`.
`SessionAdd`	When the session is created.
`IdTypeCheckStart` / `IdTypeCheckFinish`	When identity type check starts / finishes.
`HologramStart` / `HologramFinish`	When hologram check starts / finishes.
`OcrStart` / `OcrFinish`	When OCR reading starts / finishes.
`NfcStart` / `NfcFinish`	When NFC reading starts / finishes.
`FaceStart` / `FaceFinish`	When face recognition starts / finishes.
`RoomIdSend`	When video call room Id is sent.
`AgentCallAccepted`	When the agent accepts the call.
`AgentCallClose`	When the agent closes the call.
`VideoUploadFinish`	When video upload is completed.
`SessionClose`	When the session is closed.
`SigningSet` / `SigningFinish`	When signing is set / finished.

Integration/UserMap — Relationship Manager User Mapping¶

If the call includes the Relationship Manager feature, EnQualify calls the Integration/UserMap method to find the correct agent.

Expected Request¶

Parameter	Description
`Reference`	Reference Id sent in `Integration/Add`.
`IdentityType`	The identity type of the caller.
`IdentityNo`	The identity number of the caller.
`CallType`	The type of the call.

Expected Response¶

Parameter	Description
`UserReference`	User reference code. Should match one of the users defined in EnQualify. Multiple user references may be returned.
`UserOrder`	The order of users when multiple users are returned.
`UserExpireDate`	The expiration date and time of this user mapping.