Upload an ID Document image (binary)

PUT 
/api/web/v1/idproofing/:requestId/image/:side

Uploads the front (side = 0) or back (side = 1) of an ID document. Caller requires the IDPROOFING:EDIT permission.

Request

Path Parameters

requestId stringrequired

The UUID of the ID Proofing request.

side int32required

The side of the ID document image.

application/octet-stream

Body

required

string

Responses

200

Successful

application/json

Schema

Schema

countryCode string

The ID document country code.

documentClass string

Possible values: [UNKNOWN, PASSPORT, VISA, DRIVERSLICENSE, IDENTIFICATIONCARD, PERMIT, CURRENCY, RESIDENCEDOCUMENT, TRAVELDOCUMENT, BIRTHCERTIFICATE, VEHICLEREGISTRATION, OTHER, WEAPONLICENSE, TRIBALIDENTIFICATION, VOTERIDENTIFIACTION, MILITARY]

The ID document class.

presentationChanged boolean

Indicates that the document was presented with the back-side specified as the front-side and vice versa.If this occurs, all subsequent image posts must account for this presentation change.

supportedBackImage boolean

Indicates that the document type has a back side.

supportedFrontImage boolean

Indicates that the document type has a front side.

Example (from schema)

{
  "countryCode": "USA",
  "documentClass": "PASSPORT",
  "presentationChanged": true,
  "supportedBackImage": false,
  "supportedFrontImage": true
}

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...