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

# List identity checks

> Lists each party's newest identity check under this merchant, newest first, and none of a removed party's.

Credentials: `partner`, `merchant`

Permission: `identity-verifications:list`



## OpenAPI

````yaml /api-reference/v1/openapi.json get /merchants/{id}/identity-verifications
openapi: 3.1.0
info:
  title: Quidkey API
  version: 1.0.0
  description: >-
    The Quidkey public API.


    Within a version, a response can carry what this document doesn't list yet:
    a new field, a new value of an enum, a new error code. Handle a value you
    don't recognise rather than refusing the response. A client generated from
    this document turns an `enum` into a closed type unless told otherwise, so
    turn on its option for unknown values, such as openapi-generator's
    `enumUnknownDefaultCase`. A request is held to what's listed: a value it
    doesn't list is refused.
  contact:
    name: Quidkey
    url: https://docs.quidkey.com
servers:
  - url: https://api.quidkey.com/v1
security:
  - bearer: []
tags:
  - name: account_owner
  - name: agreement
  - name: agreement_acceptance
  - name: api_key
  - name: bank
  - name: bank_account
  - name: capability
  - name: country
  - name: identity_verification
  - name: legal_entity
  - name: merchant
  - name: party
  - name: payment_link
  - name: payout
  - name: transaction
  - name: webhook_endpoint
paths:
  /merchants/{id}/identity-verifications:
    get:
      tags:
        - identity_verification
      summary: List identity checks
      description: >-
        Lists each party's newest identity check under this merchant, newest
        first, and none of a removed party's.


        Credentials: `partner`, `merchant`


        Permission: `identity-verifications:list`
      operationId: identity_verification.list
      parameters:
        - name: id
          in: path
          required: true
          schema:
            minLength: 1
            type: string
        - name: cursor
          in: query
          required: false
          description: >-
            An opaque cursor from `next_cursor`, valid with the filters it was
            issued for.
          schema:
            minLength: 1
            maxLength: 1024
            type: string
        - name: limit
          in: query
          required: false
          description: The page size.
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: integer
        - name: party_id
          in: query
          required: false
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 100
            type: array
            items:
              type: string
        - name: status
          in: query
          required: false
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 9
            type: array
            items:
              type: string
              enum:
                - created
                - in_progress
                - processing
                - in_review
                - approved
                - declined
                - abandoned
                - expired
                - failed
      responses:
        '200':
          description: A list of identity_verification, in the full view.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - result
                  - entities
                  - not_included
                  - pagination
                properties:
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityVerificationFull'
                  entities:
                    additionalProperties: false
                    description: Nothing can be included here.
                    type: object
                    properties: {}
                  not_included:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotIncludedEntry'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
        '400':
          description: '`VALIDATION_FAILED`: The request is malformed or failed validation.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - VALIDATION_FAILED
        '401':
          description: '`UNAUTHENTICATED`: A valid bearer token is required.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - UNAUTHENTICATED
        '403':
          description: >-
            `FORBIDDEN`: This credential doesn't have permission for this
            endpoint.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - FORBIDDEN
        '404':
          description: '`NOT_FOUND`: Not found.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_FOUND
        '406':
          description: '`NOT_ACCEPTABLE`: This endpoint doesn''t offer the format in Accept.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_ACCEPTABLE
        '429':
          description: '`RATE_LIMITED`: Too many requests.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - RATE_LIMITED
        '500':
          description: '`INTERNAL_ERROR`: Something went wrong on our side.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - INTERNAL_ERROR
        '503':
          description: '`SERVICE_UNAVAILABLE`: The service is busy. Try again shortly.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - SERVICE_UNAVAILABLE
components:
  headers:
    RequestId:
      description: Identifies this request. Quote it to support.
      schema:
        type: string
    RetryAfter:
      description: How many seconds to wait before retrying.
      schema:
        minimum: 0
        type: integer
  schemas:
    IdentityVerificationFull:
      additionalProperties: false
      type: object
      required:
        - _type
        - _uri
        - _view
        - id
        - created_at
        - updated_at
        - status
        - name_check_status
        - failure
        - party
        - link_expires_at
      properties:
        _type:
          const: identity_verification
          type: string
        _uri:
          pattern: ^/
          description: The canonical URI, relative to the version root.
          type: string
        _view:
          const: full
          type: string
        id:
          type: string
        created_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        updated_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        status:
          type: string
          enum:
            - created
            - in_progress
            - processing
            - in_review
            - approved
            - declined
            - abandoned
            - expired
            - failed
          description: >-
            Where this attempt stands.


            - `created`: Started, with no step of it finished. The person may
            have opened the link.

            - `in_progress`: A step is under way, which may be the person's or
            the check's own.

            - `processing`: A step has finished, and the check is working on it.
            The person may have more to do after it.

            - `in_review`: Parked for a manual decision, which doesn't change
            this attempt. Starting another check replaces it, which spends a
            paid check.

            - `approved`: The check passed. It proves a person and a document,
            and not that they're this party, which `name_check_status` says. The
            party's `verification_status` is Quidkey's own decision, and doesn't
            move with it.

            - `declined`: The check declined the person.

            - `abandoned`: The person didn't finish.

            - `expired`: The link lapsed with a step still under way. A `POST`
            replaces this attempt with a new one, which spends a paid check,
            even if that step was the check's own and still working, and what
            the step finds is dropped.

            - `failed`: The check couldn't be completed on our side.
        name_check_status:
          anyOf:
            - type: string
              enum:
                - pending
                - match
                - mismatch
                - unavailable
            - type: 'null'
          description: >-
            Whether the name on the verified document matched the party, as the
            party stood when it was judged. Changing the party's name doesn't
            judge it again. `null` unless `status` is `approved`. A check can
            read `approved` and `mismatch` together, and Quidkey's review deals
            with that.


            - `pending`: Not judged yet.

            - `match`: The names matched.

            - `mismatch`: The names didn't match. Another check can be started.

            - `unavailable`: It couldn't be judged, because no name could be
            read from the document or none is held for the party. Another check
            can be started.
        failure:
          anyOf:
            - $ref: '#/components/schemas/Failure'
            - type: 'null'
          description: >-
            `null` unless `status` is `declined` or `failed`.


            - `IDENTITY_CHECK_DECLINED`: The check declined the person. `status`
            is `declined`.

            - `IDENTITY_CHECK_FAILED`: The check couldn't be completed on our
            side. `status` is `failed`.
        party:
          $ref: '#/components/schemas/PartyLink'
        hosted_link:
          $ref: '#/components/schemas/OneTimeHostedLink'
        link_expires_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
          description: >-
            When the link stops working, if one was issued. An attempt the
            person has finished keeps the time it had. `null` when none is held,
            and such an attempt never reads `expired`.
    NotIncludedEntry:
      additionalProperties: false
      type: object
      required:
        - link
        - reason
      properties:
        link:
          $ref: '#/components/schemas/AnyLink'
        reason:
          type: string
          enum:
            - no_permission
            - not_published
          description: >-
            Why this link has no entity.


            - `no_permission`: This credential can't read it. Fetching it
            answers 403, or 404 where a 403 would reveal that it exists.

            - `not_published`: The API doesn't show it: a type it doesn't
            publish, or a record it doesn't show on a type it does, such as a
            failed payout. Fetching it, where it has a URI, answers 404.
    CursorPagination:
      additionalProperties: false
      type: object
      required:
        - type
        - limit
        - next_cursor
        - has_more
      properties:
        type:
          const: cursor
          type: string
        limit:
          minimum: 1
          maximum: 100
          type: integer
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
        has_more:
          type: boolean
    Error:
      additionalProperties: false
      type: object
      required:
        - error
      properties:
        error:
          additionalProperties: false
          type: object
          required:
            - code
            - message
            - details
            - retryable
            - request_id
          properties:
            code:
              description: Branch on this. New codes can appear.
              type: string
            message:
              description: For people. It can change.
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
            retryable:
              description: >-
                Whether sending the same request again unchanged, after a wait,
                can succeed with nothing else changing.
              type: boolean
            request_id:
              description: Quote this to support.
              type: string
    Failure:
      additionalProperties: false
      type: object
      required:
        - code
        - message
      properties:
        code:
          description: >-
            Public and stable, and listed on the field that holds it. New codes
            can appear, so handle any you don't recognise.
          type: string
        message:
          type: string
    PartyLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: party
          type: string
        id:
          type: string
      x-link-target:
        resource: party
        kind: resource
        is_published: true
        views:
          - full
    OneTimeHostedLink:
      description: >-
        A page a person opens, on HTTPS in production. Its URL can carry a
        token, so treat it as a secret.
      additionalProperties: false
      type: object
      required:
        - url
        - expires_at
      properties:
        url:
          format: uri
          type: string
        expires_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
      x-one-time-secret: true
    AnyLink:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - _link
            - _type
            - id
          properties:
            _link:
              pattern: ^/
              type: string
            _type:
              type: string
            id:
              type: string
        - additionalProperties: false
          type: object
          required:
            - _type
            - id
          properties:
            _type:
              type: string
            id:
              type: string
      x-link-target:
        resource: any
        kind: any
        is_published: true
    ErrorDetail:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - field
            - message
          properties:
            field:
              type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - required_actions
            - message
          properties:
            required_actions:
              description: The `required_actions` codes holding this back.
              type: array
              items:
                type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - available_percent
            - message
          properties:
            available_percent:
              $ref: '#/components/schemas/Percent'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - current_agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            current_agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - legal_entity
            - message
          properties:
            legal_entity:
              $ref: '#/components/schemas/LegalEntityLink'
            message:
              type: string
    Percent:
      pattern: ^\d+(\.\d+)?$
      description: 'A percentage as a decimal string: `"25.00"` is 25%.'
      type: string
    AgreementLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: agreement
          type: string
        id:
          type: string
      x-link-target:
        resource: agreement
        kind: resource
        is_published: true
        views:
          - full
    LegalEntityLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: legal_entity
          type: string
        id:
          type: string
      x-link-target:
        resource: legal_entity
        kind: resource
        is_published: true
        views:
          - full
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.