Smart credential start signature

PUT 
/api/web/v1/smartcredentials/:id/startsign

Smart credential start sign. Caller requires the SMARTCREDENTIALSSIGNATURE:ADD permission.

Request

Path Parameters

id stringrequired

The UUID of the smart credential.

application/json

Body

required

digest string

The digest value that will be signed by the smart credential.

digestHashAlg string

The hashing algorithm that will be used to sign the digest value. It must be one of the values "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512".

digestKey string

Possible values: [PIV_AUTHENTICATION, DIGITAL_SIGNATURE, CARD_AUTHENTICATION]

Specify which key on the smart credential is used to sign the digest. If not specified it defaults to PIV_AUTHENTICATION.

summary string

The smart credential push signature challenge that appears in the user's mobile application.

Responses

200

Successful

application/json

Schema

Schema

transactionId string

The smart credential push signature transactionId returned from the start sign operation.

Example (from schema)

{
  "transactionId": "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...