# Update KYC document matches

Updates the document matches of a KYC document with a specified ID.

> Note: Use this operation for manual overrides.

Endpoint: POST /kyc-documents/{id}/matches
Version: latest
Security: SecretApiKey, JWT

## Path parameters:

  - `id` (string, required)
    ID of the resource.

## Request fields (application/json):

  - `body` (KycIdentityMatches (object) or KycAddressMatches (object), required) — one of:
    - KycIdentityMatches:
      - `containsImage` (boolean)
        Specifies if the document includes an image that contains a face.
        Example: true
      - `isIdentityDocument` (boolean)
        Specifies if the document resembles an ID.
        Example: true
      - `isPublishedOnline` (boolean)
        Specifies if an exact match of the document has been found online.
      - `firstName` (string,null)
        First name of the customer.
This value is null if no match is found.
        Example: "John"
      - `lastName` (string,null)
        Last name of the customer.
This value is null if no match is found.
        Example: "Doe"
      - `dateOfBirth` (string,null)
        Date of birth detected on the document.
This value is null if no match is detected.
      - `expirationDate` (string,null)
        Expiration date detected on the document.
This value is null if no expiration date is detected.
      - `issueDate` (string,null)
        Issue date detected on the document.
This value is null if no issue date is detected.
      - `nationality` (string,null)
        Nationality detected on a passport or citizenship document.
This value is null if no nationality is detected.
        Example: "US"
      - `issuanceCountry` (string,null)
        Country that issued the document.
        Example: "CA"
      - `issuanceRegion` (string,null)
        Region, state, province, or territory that issued the document.
        Example: "Ontario"
      - `documentNumber` (string,null)
        Unique number on the identity document.
This value may contain alphanumeric characters.
        Example: "1234567890"
      - `sex` (string,null)
        MRZ sex code (ICAO 9303).
M, F, or X.
Null if not extracted.
        Example: "M"
      - `documentSubtype` (string,null)
        Interpreted subtype of the uploaded document.
        Enum: "passport", "id-card", "driver-license", "birth-certificate", "utility-bill", "rental-receipt", "lease-agreement", "copy-credit-card", "credit-card-statement", "bank-statement", "inheritance-documentation", "tax-return", "salary-slip", "sale-of-assets", "public-health-card", "proof-of-age-card", "reverse-of-id", "public-service", "ewallet-holder-details", "ewallet-transaction-statement", "marriage-certificate", "firearms-license", "insurance-letter", "income-statement", "debtors-letter", "other", null
      - `hasMatchingFaceProof` (boolean)
        Specifies if an identity document has matching face proof.
      - `isTampered` (boolean)
        Specifies if an identity document has been tampered with.
      - `isDigitallyTampered` (boolean)
        Specifies if an identity document has been digitally tampered with (experimental).
      - `isPhotocopy` (boolean)
        Specifies if an identity document is detected as a photocopy.
      - `expiryDate` (string,null)
        Use expirationDate field instead.
    - KycAddressMatches:
      - `firstName` (string,null)
        First name of the customer.
This value is null if no match is found.
        Example: "John"
      - `lastName` (string,null)
        Last name of the customer.
This value is null if no match is found.
        Example: "Doe"
      - `line1` (string,null)
        Address of the customer's residence.
This value is null if no match is found.
        Example: "36 Craven St"
      - `city` (string,null)
        Customer's city of residence.
This value is null if no match is found.
        Example: "London"
      - `region` (string,null)
        Customer's region of residence.
This value is null if no match is found.
        Example: "London"
      - `postalCode` (string,null)
        Postal code of the customer's residence.
This value is null if no match is found.
        Example: "WC2N 5NF"
      - `wordCount` (integer)
        Total number of words in the document.
        Example: 350
      - `uniqueWords` (integer)
        Total number of unique words in the document.
        Example: 175
      - `date` (string,null)
        Date detected on the document.
Use this field to determine if the document is recent.
        Example: "2021-01-01"
      - `phone` (string,null)
        Phone number of the company or agency that issued the document.
        Example: "(123) 456-7890"
      - `documentSubtype` (string,null)
        Interpreted subtype of the uploaded document.
        Enum: same as `documentSubtype` in "KycIdentityMatches" (27 values)
      - `isTampered` (boolean)
        Specifies if an address proof document has been tampered with.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 404 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 429 fields (application/json):

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".
    Example: "about:blank"

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.


## Response 204 fields