Menu
Close
EmailContact
LoginLogin

Profile Status Explaination

Profile status update

This webhook is triggered when the status of the profile changes as indicated in the figure below. 

For the purpose of illustration, the video KYC (V-KYC) package has been considered. 

 

 

W1: in-progress

When is this triggered?

On successful initiation of the Profile subtasks. 

What do you infer?

All relevant documents have been captured by the user.
The video call session has ended.

Example: The successful completion of a video call.

Next Steps

Update Profile Status to ‘in_progress’.

 

W2: processed

When is this triggered?

On completion of all processing activities (like video-stitching etc.)

What do you infer?

– The initiated checks have been completed. 

– Webhook will contain the success/failure response.

– Terminal state (if review is disabled in the package).

Example: All checks performed during the video call are available for download (i.e. agent performed checks and video resources).

Next Steps

For package with review enabled:

– Update Profile Status to ‘processed’.

For package with review disabled:

– Update Profile Status to ‘processed’.

– Store the responses of assisted V-KYC and all its child tasks.

– Download the image and video resources.

– Save text resources obtained during the video call. e.g. PAN Id no.

 

W3: review_required

When is this triggered?

If a processed profile 

– Needs review,

– Does not meet the straight-pass through criteria. (coming soon).

What do you infer?

A manual review/intervention is required by an operations agent.

Example: Starting the checker process in assisted V-KYC.

Next Steps

Update Profile Status to ‘review_required’.

 

W4a: Completed

When is this triggered?

The reviewer approves or rejects the captured documents.

What do you infer?

The exact approval/rejection status can be referred in an API response tag reviewer_action. The final results can be sent to your KYC repository systems by the operations team or as instructed through a code.

Next Steps

Update Profile Status to ‘completed’.

 

W4b: Recapture-pending

When is this triggered?

The reviewer makes a request for documents to be recaptured.

What do you infer?

– Users can be notified of the recapture process. 

– The capture link can be resent to the users.

Next Steps

Update Profile Status to ‘recapture_pending’.

 

W5: Cancelled

When is this triggered?

The reviewer cancels the review request from the dashboard.

What do you infer?

N/A

Next Steps

Update Profile Status to ‘cancelled’.

 

W6: Failed

When is this triggered?

In case of

1. System failure (e.g.hardware failure or OS crash)

2. Capture link has expired,

3. Artifacts captured during the create profile stage are invalid.

What do you infer?

N/A

Next Steps

Update Profile Status to ‘failed’.

 

W7: Purged (coming soon)

When is this triggered?

After all relevant data for the user has been downloaded at the client server.

What do you infer?

User’s PII data has been deleted from IDfy’s servers.

Next Steps

Update Profile Status to ‘purged’.


IDfy Status

Client

Webhook

Profile Status

When is this webhook triggered?

What do you infer?

Next Steps

W-1

In_progress

On successful initiation of the Profile subtasks 

All relevant documents have been captured by the user.
The video call session has ended.

Example: The successful completion of a video call.

Update Profile Status to ‘in_progress’

W-2

Processed 

On completion of all processing activities (like video-stitching etc.)

– The initiated checks have been completed. 

– Webhook will contain the success/failure response

– Terminal state (if review is disabled in the package)

Example: All checks performed during the video call are available for download (i.e. agent performed checks and video resources).

For review enabled:

– Update Profile Status to ‘processed’

For review disabled:

– Update Profile Status to ‘processed’

– Store the responses of assisted V-KYC and all its child tasks.

– Download the image and video resources.

– Save text resources obtained during the video call. E.g. PAN Id no.

W-3

Review_required

If a processed profile 

– Needs review 

– Does not meet the     

  straight-pass through 
  criteria. (coming soon)

A manual review/intervention is required by an operations agent.

Example: Starting the checker process in assisted V-KYC.

Update Profile Status to ‘review_required’

W-4a

Approved/Rejected

The agent (Checker) approves or rejects the captured documents.

The final results can be sent to the KRA systems by the operations team or as instructed through a code. The exact approval/rejection status can be referred in an API response tag reviewer_action. 

Update Profile Status to ‘completed’’

W-4b

Recapture-pending

The agent (Checker) makes a request for documents to be recaptured.

– Users can be notified of the recapture process. 

– The capture link can be resent to the users.

Update Profile Status to ‘recapture_pending’

W-5

Cancelled

The agent (Checker) cancels the review request from the dashboard..

N/A

Update Profile Status to ‘cancelled’

W-6

Failed

In case of,

1. System failure

2. Capture link has expired

3. Artifacts captured during the create profile stage are invalid.

N/A

Update Profile Status to ‘failed’

W-7

Purge 

After all relevant data for the user has been downloaded at the client server.

User’s PII data has been deleted from IDfy’s servers

Update Profile Status to ‘purged’

Main Sections