> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iinkedsign.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verification result

<ResponseField name="verificationResultId" type="string">
  Unique identifier for the verification result.
</ResponseField>

<ResponseField name="verificationId" type="string">
  Unique identifier for the verification.
</ResponseField>

<ResponseField name="timeCreated" type="date">
  Time verification result record was created.
</ResponseField>

<ResponseField name="passed" type="boolean">
  Set to `true` if the verification result has passed.
</ResponseField>

<ResponseField name="noRetry" type="boolean">
  Set to `true` if the verification result has failed and the signer can no longer retry.
</ResponseField>

<ResponseField name="expired" type="boolean">
  Set to `true` if the verification result has expired and can no longer be completed by signer.
</ResponseField>

<ResponseField name="scores" type="Map<string, integer>">
  Dictionary of verification results and their pass/fail score.

  <Note>
    Score mapping: -1 = missing, 0 = failed/no match, 50 = partial match, 100 = passed.
  </Note>

  <Expandable title="keys">
    | Value                                    | Description                        | Version |
    | ---------------------------------------- | ---------------------------------- | ------- |
    | credit\_fraud                            | Fraud Check                        |         |
    | credit\_six\_month\_residency            | Six Month Residency Check          |         |
    | credit\_three\_year                      | Three Year Credit Check            |         |
    | document                                 | Identification                     |         |
    | document\_confidence                     | Document Confidence                | 3.5     |
    | document\_live\_photo\_liveness          | Live Selfie Liveness Detection     |         |
    | document\_live\_photo\_match             | Live Selfie Matches Document Photo | 3.5     |
    | identity                                 | Identity                           |         |
    | kba                                      | Knowledge Based Answers            |         |
    | security\_check\_country                 | Country Match                      |         |
    | security\_check\_data                    | Data Crosscheck Analysis           |         |
    | security\_check\_document\_type          | Document Type Match                |         |
    | security\_check\_features                | Security Feature Analysis          |         |
    | security\_check\_live\_photo             | Live Selfie Match                  |         |
    | security\_check\_session                 | Session Analysis                   | 3.5     |
    | security\_check\_tampering               | Tampering Analysis                 |         |
    | security\_valid\_data                    | Data Format Analysis               |         |
    | security\_valid\_document                | Data Analysis                      |         |
    | security\_valid\_document\_type          | Document Type Analysis             |         |
    | security\_valid\_machine\_readable\_data | Machine Readable Data Analysis     |         |
    | security\_valid\_ocr                     | OCR Analysis                       | 3.5     |
    | security\_valid\_photos                  | Photo Analysis                     | 3.5     |

    {/* | document_manual | Document was manually verified | 3.x | */}
  </Expandable>
</ResponseField>

<ResponseField name="scoresDescription" type="Map<string, string>">
  Dictionary of messages associated with each score in `scores`.
</ResponseField>

<ResponseField name="fieldScores" type="Map<string, integer>">
  Dictionary of verification input fields and their pass/fail score.
</ResponseField>

<ResponseField name="fields" type="Map<string, object>">
  Dictionary of verification input fields and their values used to generate the results.

  <Expandable title="keys">
    | Key                        | Label             |
    | -------------------------- | ----------------- |
    | address                    | Address           |
    | city                       | City              |
    | credit\_details\_trulioo   | Credit            |
    | dob\_day                   | DOB Day           |
    | dob\_month                 | DOB Month         |
    | dob\_year                  | DOB Year          |
    | document\_address          | Address           |
    | document\_address\_2       | Address 2         |
    | document\_city             | City              |
    | document\_class            | Class             |
    | document\_country\_code    | Country           |
    | document\_dob\_day         | Birth Day         |
    | document\_dob\_month       | Birth Month       |
    | document\_dob\_year        | Birth Year        |
    | document\_doe\_day         | Expiry Day        |
    | document\_doe\_month       | Expiry Month      |
    | document\_doe\_year        | Expiry Year       |
    | document\_doi\_day         | Issue Day         |
    | document\_doi\_month       | Issue Month       |
    | document\_doi\_year        | Issue Year        |
    | document\_first\_name      | First Name        |
    | document\_full\_name       | Full Name         |
    | document\_gender           | Gender            |
    | document\_issuer           | Issuer            |
    | document\_last\_name       | Last Name         |
    | document\_middle\_name     | Middle Name       |
    | document\_nationality      | Nationality       |
    | document\_number           | Document Number   |
    | document\_number\_2        | Document Number 2 |
    | document\_place\_of\_birth | Place of Birth    |
    | document\_postal\_code     | Postal Code       |
    | document\_subdivision      | Province          |
    | document\_type             | Document Type     |
    | email                      | Email             |
    | first\_name                | First Name        |
    | full\_name                 | Full Name         |
    | last\_name                 | Last Name         |
    | last\_name\_other          | Last Name (Other) |
    | middle\_name               | Middle Name       |
    | mobile\_number             | Mobile Number     |
    | postal\_code               | Postal Code       |
    | prefix                     | Prefix            |
    | street\_name               | Street Name       |
    | street\_number             | Street Number     |
    | street\_type               | Street Type       |
    | subdivision                | Province          |
    | unit\_number               | Unit Number       |
  </Expandable>
</ResponseField>

<ResponseField name="data" type="Map<string, object>">
  Dictionary of any additional fields and their values generated while processing the results.
</ResponseField>

<ResponseField name="error" type="string">
  May contain an error code if verification result is in a failed state.
</ResponseField>

<ResponseField name="type" type="string">
  The type of verification result.

  <Expandable title="values">
    | Value    | Description                           |
    | -------- | ------------------------------------- |
    | identity | Identity verification.                |
    | kba      | Knowledge based answers verification. |
    | document | Document verification.                |
  </Expandable>
</ResponseField>

<ResponseField name="state" type="string">
  The state of the verification result.

  <Expandable title="values">
    | State      | Description                                                                                                                       |
    | ---------- | --------------------------------------------------------------------------------------------------------------------------------- |
    | processing | Verification result is currently being processed.                                                                                 |
    | collected  | Verification input fields have been successfully collected. The input fields will be validated by a subsequent verification step. |
    | passed     | Verification result has been processed and has passed.                                                                            |
    | failed     | Verification result has been processed and has failed.                                                                            |
    | error      | An **error** occurred while processing the verification. Check the error field for reason.                                        |
  </Expandable>
</ResponseField>

<ResponseField name="documents" type="object[]">
  Documents associated with the verification result.

  <Expandable title="properties">
    <ResponseField name="verificationDocumentId" type="string">
      Unique identifier for the verification document.
    </ResponseField>

    <ResponseField name="verificationId" type="string">
      Unique identifier for the verification.
    </ResponseField>

    <ResponseField name="timeCreated" type="date">
      Time verification document record was created.
    </ResponseField>

    <ResponseField name="documentType" type="string">
      Verification document type.

      <Expandable title="values">
        | Key              | Description                                          |
        | ---------------- | ---------------------------------------------------- |
        | drivers\_license | Driver's License                                     |
        | health\_card     | Health Card                                          |
        | identity\_card   | Identity Card                                        |
        | military\_id     | Military ID                                          |
        | other            | Other (Returned when document type detection failed) |
        | passport         | Passport                                             |
        | resident\_card   | Resident Card                                        |
        | travel\_document | Travel Document                                      |
        | visa             | Visa                                                 |
        | voter\_id        | Voter ID                                             |
      </Expandable>
    </ResponseField>

    <ResponseField name="imageType" type="string">
      Verification document image type.

      <Expandable title="values">
        | Key         | Description                                                                    |
        | ----------- | ------------------------------------------------------------------------------ |
        | live\_photo | Selfie of signer captured during live selfie process of document verification. |
        | front       | Front image of document captured during document verification.                 |
        | back        | Back image of document captured during document verification.                  |
        | passport    | Image of passport captured during document verification.                       |
      </Expandable>
    </ResponseField>

    <ResponseField name="url" type="string">
      URL to download document or document image from.

      <Tip>
        Document URLs returned by the verification endpoint have a lifetime of 15 minutes.
      </Tip>

      <Note>
        As of `3.6` images now default to `WEBP` format. You can convert images to `JPEG` by appending the following query string parameter to end of the returned URL:

        `&mimeType=image/jpeg`
      </Note>
    </ResponseField>
  </Expandable>
</ResponseField>