Automation with the Connect Dashboard API
Extract and Archive. Best practice.
Personal KYC data should not sit in your KYC Connect database forever. Using the API with the archive option will allow you to securely meet your data retention requirements.
After creating an API key, you can use this Dashboard API to extract individuals' Identities, including provided personal info attributes, and store them in a secure environment.
Archived candidate Identities
When an Identity is archived in the KYC Connect Dashboard all raw KYC personal info (Identity attributes) will be deleted. Only metadata (e.g. status, history) and any certificates provided will remain.
If the Identity attribute data has been extracted using the API, candidate Identities can be automatically archived.
Encryption
To further protect candidates' personal information you can encrypt the API return data.
🛈 If you wish to use AES encryption as an additional security layer on the extracted data, please contact Blockpass directly for more information about the protocols and keys you will require.
- Generate a AES key for this API request
- Encrypt the AES key to the Blockpass Cloud Dashboard RSA public key
- Include the encrypted AES key in the header of the API request
- The AES key is recovered using the Blockpass Cloud Dashboard private key
- The API response data is encrypted using the AES key provided
KYC API data description:
refId: Merchant reference ID (e.g. Your internal User ID)blockPassID: Blockpass registration IDstatus: Status of KYC application (waiting|inreview|approved|resubmit)isArchived: KYC application archived statustrue: All KYC applications' attributes were deleted by operatorfalse: Data are still available in KYC Connect database
inreviewDate: Start review datewaitingDate: Last submitted dateapprovedDate: Approval datewillArchiveAtDate: KYC Connect will auto archive when date is reached (only returned ifArchive after extract datawas defined inAPI keymanagement settings)