Initiates an ID Proofing request, checks the risk of a device and obtains license details

POST 
/api/web/v1/idproofing/init

Caller requires the IDPROOFING:ADD permission.

Request

application/json

Body

required

clientIp string

Provided client IP address.

firstPartyBlackbox string

First-party device fingerprint.

Responses

200

Successful

application/json

Schema

Schema

acasEndpoint string

The mobile SDK license ACAS end-point.

assureIdEndpoint string

The mobile SDK license AssureID end-point.

deviceCheckDetails

object

Additional details about the device and the risk evaluation.

property name* string

Additional details about the device and the risk evaluation.

deviceCheckReason string

Additional information about the device risk assessment result.

deviceCheckResult string

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

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

frmEndpoint string

The mobile SDK license FRM end-point.

medscanEndpoint string

The mobile SDK license Medscan end-point.

ozoneEndpoint string

The mobile SDK license ozone end-point.

requestId stringrequired

ID Proofing request identifier (must be used in subsequent calls).

subscriberAccount string

The mobile SDK license subscriber account.

subscriberId string

The mobile SDK license subscriber ID for document authentication.

subscriberPassword string

The mobile SDK license subscriber password.

usPassliveEndpoint string

The mobile SDK license US Passlive end-point.

Example (from schema)

{
  "acasEndpoint": "string",
  "assureIdEndpoint": "string",
  "deviceCheckDetails": {},
  "deviceCheckReason": "Invalid blackbox",
  "deviceCheckResult": "REVIEW",
  "frmEndpoint": "string",
  "medscanEndpoint": "string",
  "ozoneEndpoint": "string",
  "requestId": "be0176b9-473b-4543-a338-101e2c899abb",
  "subscriberAccount": "maria.callas@scala.com",
  "subscriberId": "be0176b9-473b-4543-a338-101e2c899abb",
  "subscriberPassword": "string",
  "usPassliveEndpoint": "string"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...