Service details for PictureID
This section goes more into detail about some useful endpoints when integrating with PictureID:
Capture configurations
To configure the Picture ID user interface when using the Capture service (see use case 1), you can use the following endpoints:
- To configure the user interface for the first time, use the Create capture configuration endpoint.
- To update the already created configuration, use the Update capture configuration endpoint.
The available configurations for both these endpoints are available in the table below.
- Only the configurations inside the
signicatpictureidConfigelement will take effect. All other Capture configurations are not applicable for this provider. - The user interface will always be affected by the default theme enabled in your Signicat account. This means you don’t need to use
“useSignicatTheming":truesince that will always be the case.
Available configurations for PictureID are (see an example configuration below the table):
Translations
By default, the user interface of PictureID is only available in English (en) but you can add other languages yourselves by adding translations strings for those languages (see example configuration in the next section).
You can use/translate the following default strings or rephrase them as you wish (click on the arrow to the right to expand):
PictureID translation strings
start_title=Let's verify your identity
start_subtitle=You just need to take a photo of your ID.
start_mobile_banner_title=Results are best via mobile phone
start_mobile_banner_bullet_one=Send a secure link to your mobile.
start_mobile_banner_bullet_two=Follow the instructions from the link.
start_mobile_banner_bullet_three=Come back here to finish.
start_button_go_mobile=Get started with your mobile
start_button_go_desktop=Stay on this device
start_mobile_button_go=Get started
mobile_handover_title=Switch to mobile
mobile_handover_button_stay=Stay on this device
mobile_handover_qrcode_subtitle=Scan the QR code with your mobile and open the link to continue.
mobile_handover_qrcode_change_title=See other options to switch to the mobile
mobile_handover_qrcode_change_sms=Receive a link via SMS
mobile_handover_sms_subtitle=You will receive a secure link via SMS. Open it and continue without closing this window.
mobile_handover_sms_dropdown_label=See other options to switch to the mobile
mobile_handover_sms_button_send=Send link to my phone
mobile_handover_sms_button_send_loading=Sending...
mobile_handover_sms_error_general=SMS not sent. Verify your number and try again.
mobile_handover_sms_error_already_sent=SMS is already sent. Wait 5 minutes before retrying.
mobile_handover_waiting_title=Connected to your mobile
mobile_handover_waiting_subtitle=Once you have taken the photos with your mobile, we will take you to the next step.
mobile_handover_waiting_info=Don't close or refresh this window
doc_country_title=Select issuing country
doc_country_button_next=Next
doc_country_dropdown_label=Country where your ID was issued
doc_country_dropdown_placeholder=Choose an option
doc_country_dropdown_search_placeholder=Search options
doc_type_title=Select ID document
doc_type_options_label=Accepted ID documents
doc_instructions_front_title=Front side
doc_instructions_front_description=Take a photo of the front side of your ID.
doc_instructions_back_title=Back side
doc_instructions_back_description=Turn it over and photograph the back.
doc_instructions_selfie_title=Selfie
doc_instructions_selfie_description=Take a selfie, avoiding accessories such as hats or glasses.
doc_instructions_banner_title=Tips
doc_instructions_banner_bullet_one=Use an original document. Copies are not allowed.
doc_instructions_banner_bullet_two=Ensure the document is framed, clearly readable, and free of glare or blur.
doc_instructions_button_take_photo=Take photos
doc_instructions_button_upload_photo=Upload photos
upload_description=Upload photo and check that all details are clearly shown.
upload_dropbox_text=<span className='dropbox__link'>Click here to upload</span> or drag and drop your files
upload_dropbox_max_file_size=Max file size:
upload_dropbox_allowed_file_types=File types allowed:
take_photo_description_front=Frame the side with the photo.
take_photo_description_back=Turn the document over and frame the reverse.
take_photo_description_selfie=Fit your face into the frame and take a selfie.
take_photo_button_take=Take photo
confirm_description=Check that all details are clearly shown.
confirm_button_submit=Submit photo
confirm_button_retake=Retake
general_step_front=Front side
general_step_back=Back side
general_step_selfie=Selfie
doc_type_passport=Passport
doc_type_passportwithextension=Passport with extension
doc_type_identitycard=Identity card
doc_type_originidentitycard=Origin Identity Card
doc_type_identitydocument=Identity document
doc_type_biometricidentitycard=Biometric Identity Card
doc_type_driverlicense=Drivers license
doc_type_residentpermit=Resident permit
doc_type_residencepermit=Residence Permit
doc_type_residencepermitbookformat=Residence Permit - Book format
doc_type_residencecard=Residence Card
doc_type_residentidentitycard=Resident Identity Card
doc_type_traveltitle=Travel title
doc_type_workpermit=Work permit
doc_type_taxcard=Tax card
doc_type_socialsecuritycard=Social security card
doc_type_socialsecuritysystemcard=Social Security System Card
doc_type_professionalidpermit=Professional permit
doc_type_professionalidcard=Professional ID Card
doc_type_postalidentitycard=Postal identity card
doc_type_temporarypassport=Temporary passport
doc_type_cni=CNI
doc_type_cnie=CNIe
doc_type_alienpassport=Alien Passport
doc_type_euresidentpermit=EU Resident Permit
doc_type_electronicidentitycard=Electronic Identity Card
doc_type_frencholdbookdriverlicense=French Old Book Driver License
doc_type_oldidentitycardissueduntilOctober2010=Old identity card (issued until October 2010)
doc_type_czechidcardv2012=Czech ID Card v. 2012
doc_type_czechidcardv2003=Czech ID Card v.2003
doc_type_old1994identitycard=Old 1994 Identity Card
success_page_title=Identification completed
success_page_subtitle=Thank you!
error_page_title_general=Something went wrong
error_page_subtitle_general=We couldn't complete the verification. Please try again.
Example configuration
Here is an example of a valid Capture configuration for the signicatpictureid provider:
{
"signicatpictureidConfig":
{
"defaultCountry": "NLD",
"allowFileUpload":
[
"desktop"
],
"allowTakePhoto":
[
"mobile",
"desktop"
],
"allowedIdTypes":
[
222,
136,
137,
271
],
"translations":
{
"pt":
{
"start_title": "Vamos verificar a sua identidade"
}
}
}
}
Get process
This section describes the final result status that you receive in the Get process response for PictureID.
Final result status
PictureID always performs security checks of the captured ID document ("processType":"document"). If you also require a selfie ("processType":"documentSelfie"), the service will perform a face match between the photo in the ID document and the selfie.
Based on the security check results, the Assure API returns the following final statuses for the two process types:
accepted
The status is accepted when all underlying verification checks have passed. This means there are no
indications the document is fraudulent.
This is a response example of an accepted process for "processType":"documentSelfie":
{
"processId": "27e15a7a-c720-4052-b384-f6f541b12514",
"provider": "signicatpictureid",
"processType": "documentSelfie",
"status": "accepted",
"finalResult": {
"firstName": "WILLEKE LISELOTTE",
"lastName": "DE BRUIJN",
"dateOfExpiry": "2031-08-30",
"dateOfBirth": "1965-03-10",
"gender": "F",
"nationality": "NLD",
"documentNumber": "SPECI2021",
"issuingCountry": "NLD",
"similarityScore": "high",
"personalIdentificationNumber": "999999990"
},
"providerSpecific": {
"document": {
"issuingCountry": "NLD",
"dateOfExpiry": "2031-08-30",
"documentNumber": "SPECI2021",
"subject": {
"firstName": "WILLEKE LISELOTTE",
"lastName": "DE BRUIJN",
"dateOfBirth": "1965-03-10",
"gender": "F",
"nationality": "NLD",
"personalIdentificationNumber": "999999990",
"photo": {
"x": 187,
"y": 456,
"width": 376,
"height": 539
},
"signature": {
"x": 1511,
"y": 948,
"width": 598,
"height": 156
}
},
"securityChecks": {
"notTamperedDocument": {
"name": "Not tampered document",
"passed": true
},
"nonExpired": {
"name": "Document not expired",
"passed": true
},
"notUnderage": {
"name": "Not underage",
"passed": true
},
"notBlackAndWhite": {
"name": "Not black & white copy",
"passed": true
},
"dataIntegrity": {
"name": "Data integrity",
"passed": true
},
"selfieAndDocumentMatch": {
"name": "Selfie and photo in the document match",
"similarityLevel": "high"
}
}
},
"selfie": {
"status": "SUCCESS",
"x": 349,
"y": 333,
"width": 417,
"height": 702
}
},
"createdAt": "2024-12-17T00:12:12Z",
"updatedAt": "2024-12-17T00:13:38Z"
}
In this example, true is passed as value in the security checks, and highis passed as the similarity level on the selfie and ID document comparison check. This means all the underlying verifications have passed and the status is accepted.
rejected
The verification cannot be processed further. This may occur due to poor image quality, making crucial information unreadable (for example documentNumber), due to one or more security checks failing (for example notBlackAndWhite) or due to not being possible to validate the age of the end-user (notUnderage security not found). If "processType":"documentSelfie", it can also be rejected due to not having enough similarityLevel on the comparison between the selfie and the ID document (for example "veryLow", "low", "medium").
Here is an example of a "document" process that was rejected since the notUnderage security check is missing:
{
"processId": "3b1dc433-a46c-4473-bab6-d0f7c8a44341",
"provider": "signicatpictureid",
"processType": "document",
"status": "rejected",
"statusReasons":
[
{
"type": "Document",
"category": "Security",
"subCategory": "NotUnderage",
"message": "Security check 'notUnderage' failed or was not found."
}
],
"depictions": [
"front"
],
"providerSpecific": {
"document": {
"subject": {
"signature": {
"x": 260,
"y": 447,
"width": 278,
"height": 107
}
},
"securityChecks": {
"notTamperedDocument": {
"name": "Not tampered document",
"passed": true
},
"notBlackAndWhite": {
"name": "Not black & white copy",
"passed": true
},
"dataIntegrity": {
"name": "Data integrity",
"passed": false
}
}
}
},
"createdAt": "2025-05-13T08:18:28Z",
"updatedAt": "2025-05-13T08:19:47Z"
}
Here is an example of a "document" process that was rejected since the document quality is not good enough to extract the documentNumber:
{
"processId": "4aefbbf2-3c6a-44fb-9838-69ee62fadd64",
"provider": "signicatpictureid",
"processType": "document",
"status": "rejected",
"statusReasons":
[
{
"type": "Document",
"category": "ImageQuality",
"message": "Document image does not have enough quality or is not an image of an ID document (documentNumber could not be extracted)."
}
],
"depictions": [
"front"
],
"providerSpecific": {
"document": {
"subject": {
"photo": {
"x": 45,
"y": 172,
"width": 84,
"height": 108
},
"signature": {
"x": 391,
"y": 283,
"width": 210,
"height": 51
}
},
"securityChecks": {
"notTamperedDocument": {
"name": "Not tampered document",
"passed": false
},
"notBlackAndWhite": {
"name": "Not black & white copy",
"passed": true
},
"dataIntegrity": {
"name": "Data integrity",
"passed": false
}
}
}
},
"createdAt": "2025-05-14T08:02:48Z",
"updatedAt": "2025-05-14T08:03:47Z"
}
This is a response example of "documentSelfie" process that was rejected because of a very low facial similarityLevel. This could happen if the selfie is from a different person than in the ID document:
{
"processId": "589ab89e-75e8-47db-b43a-5b38ec93972c",
"provider": "signicatpictureid",
"processType": "documentSelfie",
"status": "rejected",
"statusReasons": [
{
"type": "Biometrics",
"category": "SimilarityLevel",
"message": "Similarity level is 'veryLow'."
}
],
"providerSpecific": {
"document": {
"issuingCountry": "NLD",
"dateOfExpiry": "2031-08-30",
"documentNumber": "SPECI2021",
"subject": {
"firstName": "WILLEKE LISELOTTE",
"lastName": "DE BRUIJN",
"dateOfBirth": "1965-03-10",
"gender": "F",
"nationality": "NLD",
"personalIdentificationNumber": "999999990",
"photo": {
"x": 188,
"y": 457,
"width": 376,
"height": 538
},
"signature": {
"x": 1511,
"y": 948,
"width": 598,
"height": 156
}
},
"securityChecks": {
"notTamperedDocument": {
"name": "Not tampered document",
"passed": true
},
"nonExpired": {
"name": "Document not expired",
"passed": true
},
"notUnderage": {
"name": "Not underage",
"passed": true
},
"notBlackAndWhite": {
"name": "Not black & white copy",
"passed": true
},
"dataIntegrity": {
"name": "Data integrity",
"passed": true
},
"selfieAndDocumentMatch": {
"name": "Selfie and photo in the document match",
"similarityLevel": "veryLow"
}
}
},
"selfie": {
"status": "SUCCESS",
"x": 372,
"y": 819,
"width": 352,
"height": 556
}
},
"createdAt": "2024-12-17T00:16:55Z",
"updatedAt": "2024-12-17T00:18:43Z"
}
securityChecks
This is a response example of a process that was rejected since the nonExpired security check did not pass.
{
"processId": "6aff2abb-bd88-436c-bc81-9086c32a2e2a",
"provider": "signicatpictureid",
"processType": "document",
"status": "rejected",
"statusReasons": [
{
"type": "Document",
"category": "SecurityCheckFailed",
"subCategory": "NonExpired",
"message": "Security check 'nonExpired' failed."
}
],
"providerSpecific": {
"document": {
"issuingCountry": "NLD",
"dateOfExpiry": "2031-08-30",
"documentNumber": "SPECI2021",
"subject": {
"firstName": "WILLEKE LISELOTTE",
"lastName": "DE BRUIJN",
"dateOfBirth": "1965-03-10",
"gender": "F",
"nationality": "NLD",
"personalIdentificationNumber": "999999990",
"photo": {
"x": 90,
"y": 171,
"width": 167,
"height": 235
},
"signature": {
"x": 336,
"y": 425,
"width": 298,
"height": 108
}
},
"securityChecks": {
"notTamperedDocument": {
"name": "Not tampered document",
"passed": true
},
"nonExpired": {
"name": "Document not expired",
"passed": false
},
"notUnderage": {
"name": "Not underage",
"passed": true
},
"notBlackAndWhite": {
"name": "Not black & white copy",
"passed": true
},
"dataIntegrity": {
"name": "Data integrity",
"passed": true
}
}
}
},
"createdAt": "2024-12-16T23:35:52Z",
"updatedAt": "2024-12-16T23:36:15Z"
}
similarityLevel
This is a response example of a process that was rejected since the facial similarityLevelscore is medium:
{
"processId": "589ab89e-75e8-47db-b43a-5b38ec93972c",
"provider": "signicatpictureid",
"processType": "documentSelfie",
"status": "rejected",
"statusReasons": [
{
"type": "Biometrics",
"category": "SimilarityLevel",
"message": "Similarity level is 'medium'."
}
],
"providerSpecific": {
"document": {
"issuingCountry": "NLD",
"dateOfExpiry": "2031-08-30",
"documentNumber": "SPECI2021",
"subject": {
"firstName": "WILLEKE LISELOTTE",
"lastName": "DE BRUIJN",
"dateOfBirth": "1965-03-10",
"gender": "F",
"nationality": "NLD",
"personalIdentificationNumber": "999999990",
"photo": {
"x": 188,
"y": 457,
"width": 376,
"height": 538
},
"signature": {
"x": 1511,
"y": 948,
"width": 598,
"height": 156
}
},
"securityChecks": {
"notTamperedDocument": {
"name": "Not tampered document",
"passed": true
},
"nonExpired": {
"name": "Document not expired",
"passed": true
},
"notUnderage": {
"name": "Not underage",
"passed": true
},
"notBlackAndWhite": {
"name": "Not black & white copy",
"passed": true
},
"dataIntegrity": {
"name": "Data integrity",
"passed": true
},
"selfieAndDocumentMatch": {
"name": "Selfie and photo in the document match",
"similarityLevel": "medium"
}
}
},
"selfie": {
"status": "SUCCESS",
"x": 372,
"y": 819,
"width": 352,
"height": 556
}
},
"createdAt": "2024-12-17T00:16:55Z",
"updatedAt": "2024-12-17T00:18:43Z"
}
failed
In this example the process failed due to an expired transaction. This might happen if the end-user spends too long time on the verification process. The end-user has 15 minutes to complete the process after uploading the first image.
{
"processId": "8fba52bb-1734-4cec-b327-2470fd6f29bd",
"provider": "signicatpictureid",
"processType": "document",
"status": "failed",
"failReason": {
"detail": "Transaction time expired."
},
"depictions": [
"front"
],
"createdAt": "2025-01-08T15:41:59Z",
"updatedAt": "2025-01-08T16:05:18Z"
}
canceled
The identity verification process was cancelled by the end-user.
{
"processId": "e1bba176-5dff-4acc-ba4d-5dafe4d66ca3",
"provider": "signicatpictureid",
"processType": "document",
"status": "canceled",
"createdAt": "2024-12-16T23:32:01Z",
"updatedAt": "2024-12-16T23:32:28Z"
}
Download full result
In the "Get process" response, you get the results for PictureID in the provider-specific area, normalised by Assure API. To get the raw results, as they were obtained from the provider, use the Download full result service. The result is returned in a zip file.
You can always get a zip file for PictureID processes that have been completed with success.
File example
The name of the zip file is based on field values in the process, consisting of "dossierId_processId_downloadDate.zip", for example fe4cda65-bb97-477b-acc4-7ee2af64914c_46385ffb-4485-44ce-be71-b0aaef466338_20241204T224400.zip.
Here is a screen example of a zip file from a PictureID process:
PictureID zip file
File content
The main content is as follows:
- ID document image(s) (front and back if available) in JPG format.
- The full result in JSON format.
- Selfie image in JPG format if the process type is
documentSelfie.