API Snapshot Type Feature

API snapshot type feature allows user to extract Risk Assessment report in Json, XML and Base64 format using API which in turn can be converted into Pdf using external tools


To use document fetch (API snapshot) feature you would need an additional API snapshot subscription with KYC360

Once the option is enabled on your environment, User will find an option to configure snapshot type  within onboarding types.

 

You would go into KYC360 => Configure => Onboarding Type => API Snapshot Type => With Document.

Please note

With Document – ‘With Document’ option will  fetch  attach documents which are uploaded my prospect at data collection stage.

Without Document – Without Document' option  will ignore the attached document in API response

On successful completion of Onboarding Journey, you would use to get onboarding API call.

Navigation: APIX => Onboarding => Onboarding => APIX Document

/api/v1/client/onboarding/get

/api/v1/client/onboarding/getall

 

Here, you would use,

Business Unit ID – Unique Business Unit Id of an Opcos

Client Prospect ID – Unique Client Prospect Identifier

Include Document Data – Use Boolean Value as True to get document.

Return Encoded Values – Set True to get Base64 encoded values or set to false.

Return Format – Json or XML

 

This API will give you similar report which you can extract it from KYC360 UI.

 

You can use this API to get results in Json, XML or Base64 format which in turn can be converted into PDF using Custom code or External Tool.