Retrieving the database verification product information relating to the conversation (GET)

Returns information about how the database verification process is performed for the given conversation ID. Results are available when the appropriate callback is received, or when the databaseVerification status reaches FINISHED OR FAILED.

Response Content

Detailed description of returned fields:

Parameter	Example	Description
source	-	List of database verification source results.
source.name	MATCHING	Type of the database verification use case (MATCHING / ENRICHMENT).
source.status	FINISHED	Processing status of the source (FINISHED / FAILED).
source.sourceName	Australia Residential	Name of the source/database.
source.sourceType	MARKETING	Type of the source/database (MARKETING / GOVERNMENT).
source.sourceMatchResult	NO_MATCH	Overall match result (FULL_MATCH / PARTIAL_MATCH / NO_MATCH).
source.errors	SOURCE_UNAVAILABLE	Information about the causes of errors. The content depends on the specific verification source.
source.sourceMatchedScores	-	Per-attribute numeric match scores, keyed by attribute name.
source.sourceMatchedAttributes	-	Per-attribute boolean match results.
source.sourceMatchedAttributes.name.firstName	true	First name matched.
source.sourceMatchedAttributes.name.lastName	true	Last name matched.
source.sourceMatchedAttributes.name.middleName	false	Middle name matched.
source.sourceMatchedAttributes.name.fullName	true	Full name matched.
source.sourceMatchedAttributes.ids.nationalId	true	National ID matched.
source.sourceMatchedAttributes.ids.taxNumber	true	Tax number matched.
source.sourceMatchedAttributes.ids.idCard.id	true	ID card number matched.
source.sourceMatchedAttributes.ids.idCard.issueDate	false	ID card issue date matched.
source.sourceMatchedAttributes.ids.idCard.expiryDate	false	ID card expiry date matched.
source.sourceMatchedAttributes.ids.idCard.additionalId	false	Additional ID card number matched.
source.sourceMatchedAttributes.ids.idCard.version	false	ID card version matched.
source.sourceMatchedAttributes.ids.idCard.canceled	false	ID card cancellation status matched.
source.sourceMatchedAttributes.ids.driverLicence.id	true	Driver licence number matched.
source.sourceMatchedAttributes.ids.driverLicence.issueDate	false	Driver licence issue date matched.
source.sourceMatchedAttributes.ids.driverLicence.expiryDate	false	Driver licence expiry date matched.
source.sourceMatchedAttributes.ids.driverLicence.additionalId	false	Additional driver licence number matched.
source.sourceMatchedAttributes.ids.driverLicence.version	false	Driver licence version matched.
source.sourceMatchedAttributes.ids.driverLicence.canceled	false	Driver licence cancellation status matched.
source.sourceMatchedAttributes.ids.passport.id	true	Passport number matched.
source.sourceMatchedAttributes.ids.passport.issueDate	false	Passport issue date matched.
source.sourceMatchedAttributes.ids.passport.expiryDate	false	Passport expiry date matched.
source.sourceMatchedAttributes.ids.passport.additionalId	false	Additional passport number matched.
source.sourceMatchedAttributes.ids.passport.version	false	Passport version matched.
source.sourceMatchedAttributes.ids.passport.canceled	false	Passport cancellation status matched.
source.sourceMatchedAttributes.info.gender	false	Gender matched.
source.sourceMatchedAttributes.info.birthDate	true	Birth date matched.
source.sourceMatchedAttributes.address.text	false	Full address text matched.
source.sourceMatchedAttributes.address.addressLine	false	Address line matched.
source.sourceMatchedAttributes.address.street	false	Street matched.
source.sourceMatchedAttributes.address.building	false	Building matched.
source.sourceMatchedAttributes.address.flat	false	Flat matched.
source.sourceMatchedAttributes.address.postalCode	true	Postal code matched.
source.sourceMatchedAttributes.address.city	true	City matched.
source.sourceMatchedAttributes.address.country	true	Country matched.
source.sourceMatchedAttributes.address.state	false	State matched.
source.sourceMatchedAttributes.address.district	true	District matched.
source.sourceMatchedAttributes.contact.email	true	Email matched.
source.sourceMatchedAttributes.contact.phone	false	Phone matched.
source.sourceMatchedAttributes.contact.landlineNumber	false	Landline number matched.
source.additionalData	-	Additional enrichment data from the source. Available when source name is ENRICHMENT.
source.additionalData.name.firstName	Jan	First name from the source.
source.additionalData.name.lastName	Kowalski	Last name from the source.
source.additionalData.name.middleName	Maria	Middle name from the source.
source.additionalData.name.fullName	Jan Kowalski	Full name from the source.
source.additionalData.ids.nationalId	12345678901	National ID from the source.
source.additionalData.ids.idCard.isValid	true	Whether the ID card is valid.
source.additionalData.ids.idCard.isCancelled	false	Whether the ID card is cancelled.
source.additionalData.info.gender	MALE	Gender from the source (MALE/FEMALE/OTHER).
source.additionalData.info.birthDate	1985-01-01	Birth date from the source.
source.additionalData.address.addressLine	Ul. Przykładowa 1	Address line from the source.
source.additionalData.address.text	Ul. Przykładowa 1, 00-000 Miasto	Full address text from the source.
source.additionalData.address.city	Miasto	City from the source.
source.additionalData.address.postalCode	00-000	Postal code from the source.
source.additionalData.address.state	Mazowieckie	State from the source.
source.additionalData.address.district	Warszawa	District from the source.
source.additionalData.address.country	PL	Country from the source.

Retrieving the database verification product information relating to the conversation

Response Content

Parameters

Responses