Skip to main content

Lists a page of ID Proofing requests

POST 
/api/web/v1/idproofing

Returns ID Proofing requests for the provided search parameters. Caller requires the IDPROOFING:VIEW permission. The following searchByAttributes are supported:

  • requestTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • deviceCheckResult: a String value. Allowed operator: EQUALS. Allowed values: ALLOW, DENY, NONE, REVIEW.
  • state: a String value. Allowed operator: EQUALS. Allowed values: COMPLETE, DEVICE, IMAGE, INIT.
  • documentAuthenticationResult: a String value. Allowed operator: EQUALS. Allowed values: NONE, UNKNOWN, PASSED, FAILED, SKIPPED, ATTENTION.
  • faceMatch: true or false. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.

The orderByAttribute supports these attribute names: requestTime, deviceCheckResult, state, documentAuthenticationResult, faceMatch.

Request​

Body

required

    attributes string[]

    Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.

    cursor string

    Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.

    limit int32

    Possible values: >= 1 and <= 100

    Identifies the maximum number of items to include in a page (1-100).

    orderByAttribute

    object

    An attribute used to sort the result from a search.

    ascending booleanrequired

    Identifies whether to order results in ascending order.

    name stringrequired

    Identifies the attribute.

    searchByAttributes

    object[]

    Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.

  • Array [

    • name stringrequired

    Identifies the attribute we are searching for.

    operator stringrequired

    Possible values: [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN, EXISTS, NOT_EXISTS]

    Identifies the operator.

    value string

    Identifies the value of the attribute we are searching for.

  • ]

Responses​

Successful

Schema

    paging

    object

    Contains navigation information.

    limit int32required

    Possible values: >= 1 and <= 100

    The page limit used (1-100)

    nextCursor string

    The cursor pointing to the next page.

    prevCursor string

    The cursor pointing to the previous page.

    results

    object[]

    required

    A single page with the list of ID Proofing requests found.

  • Array [

    • backImageClassified boolean

    Returns true if the document back image was successfully classified into a known document.

    backImageUploadTime date-time

    The time when the document ID back image was uploaded.

    deviceCheckResult stringrequired

    Possible values: [ALLOW, DENY, NONE, REVIEW]

    The device risk assessment result. A result of DENY will not allow to continue with an ID Proofing request.

    documentAuthenticationResult string

    Possible values: [NONE, UNKNOWN, PASSED, FAILED, SKIPPED, ATTENTION]

    The ID document authentication result.

    faceMatch boolean

    Returns true if the document photo and the selfie matched.

    faceMatchScore int32

    Face match score normalized to the range 0-100, where 80 or higher is considered a match. Clients should rely on the faceMatch attribute rather than the raw score.

    frontImageClassified boolean

    Returns true if the document front image was successfully classified into a known document.

    frontImageUploadTime date-time

    The time when the document ID front image was uploaded.

    requestId stringrequired

    ID Proofing request identifier.

    requestTime date-timerequired

    The time when the request was initiated.

    state stringrequired

    Possible values: [COMPLETE, IMAGE, INIT]

    The state of the request.

  • ]

Loading...