package services.connect.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Request to create an Identity Verification Session

• repeated RequestedVerification verifications = 1

  Array of verifications to perform

• map<string, string> debug_information = 2

  Debugging information used to help diagnose issues

• optional DemoRelyingParty demo_rp = 3

  Information about the Relying Party used for demo purposes. This is only to be used if the demo flag is set to true in the debug information.

• VerificationType type = 1

  The type of verification for which the credential can be used

  Name of the IDV issuer

Information about a Relying Party used for demo purposes

Used in: CreateSessionRequest

• string display_name = 1

• string logo_url = 2

• string primary_color = 3

Selection of fields to retrieve from a Government ID. All fields default to `false` unless explicitly set to `true`.

Used in: GovernmentIDOptions

• bool id_number = 1

  ID number of the underlying identity document

• bool given_name = 2

  Given ("first") name of the document holder

• bool family_name = 3

  Family ("last") name of the document holder

• bool address = 4

  Full address of the document holder

• bool date_of_birth = 5

  Date of birth of the document holder

• bool country = 6

  ISO3 country code of the document

• bool issue_date = 7

  Issuance date of the document

• bool expiration_date = 8

  Expiration date date of the document

• bool document_front = 9

  The image of the front of the document

• bool document_back = 10

  The image of the back of the document

• bool document_portrait = 11

  The image of the holder portrait contained in the document

• bool selfie = 12

  The image of the face match selfie

Options for a Verification of type `GOVERNMENT_ID`

Used in: RequestedVerification

• optional GovernmentIDFields fields = 1

  The fields to retrieve from the Government ID. If this object is not set, all fields will be retrieved.

• optional string id_number = 1

  The ID number of the underlying identity document

• optional string given_name = 2

  Given ("first") name of the document holder

• optional string family_name = 3

  Family ("last") name of the document holder

• optional string address = 4

  Full address of the document holder

• optional string date_of_birth = 5

  Date of birth of the document holder

• optional string country = 6

  ISO3 country code of the document

• optional string issue_date = 7

  Issuance date of the document

• optional string expiration_date = 8

  Expiration date date of the document

A verification to perform in an IDV flow

Used in: CreateSessionRequest

• VerificationType type = 1

  The type of verification to perform

• oneof options

  • GovernmentIDOptions government_id_options = 2

    Options for a Verification of type `GOVERNMENT_ID`

Controls how sessions are ordered in `ListSessions`

• CREATED = 0

  Order sessions according to when they were created

• UPDATED = 1

  Order sessions according to when they last changed state

• STATE = 2

  Order sessions according to their numerical state

The type of verification to perform

Used in: CredentialRequestData, RequestedVerification

• GOVERNMENT_ID = 0

  Government-issued ID (driver's license, passport, etc)