International ID V1

Sample Code:

class InternationalIdV1(raw_prediction)

Inference prediction for International ID, API version 1.

static get_endpoint_info(klass)

Retrives the endpoint information for an Inference.

Should never retrieve info for CustomV1, as a custom endpoint should be created to use CustomV1.

Parameters:

klass (Type[Inference]) – product subclass to access endpoint information.

Return type:

Dict[str, str]

endpoint_name: Optional[str] = 'international_id'

Name of the endpoint.

endpoint_version: Optional[str] = '1'

Version of the endpoint.

is_rotation_applied: Optional[bool]

Whether the document has had any rotation applied to it.

page_id: Optional[int]

Optional page id for page-level predictions.

pages: List[Page[InternationalIdV1Document]]

Page-level prediction(s).

prediction: InternationalIdV1Document

Document-level prediction.

product: Product

Name and version of a given product, as sent back by the API.

class InternationalIdV1Document(raw_prediction, page_id=None)

Document data for International ID, API version 1.

Parameters:

• raw_prediction (Dict[str, Any]) –

• page_id (Optional[int]) –

address: StringField

The physical location of the document holder’s residence.

birth_date: DateField

The date of birth of the document holder.

birth_place: StringField

The location where the document holder was born.

country_of_issue: StringField

The country that issued the identification document.

document_number: StringField

The unique identifier assigned to the identification document.

document_type: ClassificationField

The type of identification document being used.

expiry_date: DateField

The date when the document will no longer be valid for use.

given_names: List[StringField]

The first names or given names of the document holder.

issue_date: DateField

The date when the document was issued.

mrz1: StringField

First line of information in a standardized format for easy machine reading and processing.

mrz2: StringField

Second line of information in a standardized format for easy machine reading and processing.

mrz3: StringField

Third line of information in a standardized format for easy machine reading and processing.

nationality: StringField

Indicates the country of citizenship or nationality of the document holder.

sex: StringField

The document holder’s biological sex, such as male or female.

surnames: List[StringField]

The surnames of the document holder.