Skip to main content
Retrieve details from a custom document
Wrk Product avatar
Written by Wrk Product
Updated over 8 months ago

Retrieve details from a custom document type. Reach out to us to get your own custom document added.

Application

  • Intelligent Document Processing

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Document type

Type of custom document to retrieve details from

Predefined Choice List

Yes

license.pdf

Document

PNG, JPEG, TIFF, or PDF document file

File

No

Fields to capture

No

Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data library section. These variables in the Data library section are the outputs of previous Wrk Actions in the Wrkflow.

Outputs (what you get)

Name

Description

Data Type

Required?

Example

Document data extracted

A JSON object of the extract data for the document type selected

Text(Long)

Yes

All text retrieved

All the text present in the document

Text(Long)

Yes

Note: The "Fields to Capture" input feature can be used to create new outputs for the Wrk Action with the value of the corresponding key names in the "Document data extracted" output of the Wrk Action.

Quebec Drivers License Fields

Key Name

Field Description

quebec_drivers_license_first_name

First name on the driver license

quebec_drivers_license_last_name

Last name on the driver license

quebec_drivers_license_date_de_naissance

Date of birth on the driver license

quebec_drivers_license_full_address

Full address on the driver license

quebec_drivers_license_classes

Classes on the driver license

quebec_drivers_license_cond

"Cond" on the driver license

quebec_drivers_license_mentions

"Mention(s)" on the driver license

quebec_drivers_license_no_de_reference

No de reference on the driver license

quebec_drivers_license_valide_le

Valide le on the driver license

quebec_drivers_license_sexe

Sexe on the driver license

quebec_drivers_license_taille

Taille on the driver license

quebec_drivers_license_yeux

Yeux on the driver license

quebec_drivers_license_expire_le

Expire le on the driver license

quebec_drivers_license_number

Number of the driver license

Quebec Birth Certificate Fields

Key Name

Field Description

quebec_birth_certificate_no_de_document

No De Document on the birth certificate

quebec_birth_certificate_nom

Nom on the birth certificate

quebec_birth_certificate_prenoms

Prenom(s) on the birth certificate

quebec_birth_certificate_sexe

Sexe on the birth certificate

quebec_birth_certificate_lieu_de_naissance

Lieu de naissance on the birth certificate

quebec_birth_certificate_date_de_naissance

Date de naissance on the birth certificate

quebec_birth_certificate_pere_first_name

First name of the "Pere" on the birth certificate

quebec_birth_certificate_pere_last_name

Last name of the "Pere" on the birth certificate

quebec_birth_certificate_mere_first_name

First name of the "Mere" on the birth certificate

quebec_birth_certificate_date_de_deliverance

Date de deliverance on the birth certificate

quebec_birth_certificate_numero_de_inscription

Numero d' inscription on the birth certificate

Quebec Health Insurance Card Fields

Key Name

Field Description

quebec_health_insurance_numero_de_assurance_maladie

NUMERO D'ASSURANCE MALADIE on the insurance card

quebec_health_insurance_card_prenom_et_nom_a_la_naissance

PRENOM ET NOM A LA NAISSANCE on the insurance card

quebec_health_insurance_card_nom_de_lepoux_et_ou_no_sequentiel

NOM DE L'EPOUX ET/OU NO SEQUENTIEL on the insurance card

quebec_health_insurance_card_naissance

NAISSANCE on the insurance card

quebec_health_insurance_card_sexe

SEXE on the insurance card

quebec_health_insurance_card_expiration

EXPIRATION on the insurance card

Outcomes

Name

Description

Success

This status is selected if details are extracted from the documentation type selected

No Result

This status is selected in the event of the following scenarios:

  • If nothing is returned for any of the output fields

Impossible to Complete

This status is selected in the event of the following scenarios:

  • Outlined in Application Design

Requirements

  • N/A

Did this answer your question?