API reference

Risk exceptions

Limited exceptions from rules with an owner and an expiry.

List risk exceptions

GET/v1/risk-exceptions

Scopes
risk_exceptions:read

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200RiskExceptionList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Create a risk exception

POST/v1/risk-exceptions

Scopes
risk_exceptions:write
Required header
Idempotency-Key

Request bodyRiskExceptionCreate

FieldTypeRequired
factor_idstringyes
scope_typeenum: applicant, processing_contextyes
scope_idstring (uuid)yes
reasonstringyes
expires_atstring (date-time)yes

Responses

  • 201RiskException
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get a risk exception

GET/v1/risk-exceptions/{exception_id}

Scopes
risk_exceptions:read

Parameters

FieldTypeRequired
exception_idpathstring (uuid)yes

Responses

  • 200RiskException
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Revoke a risk exception

DELETE/v1/risk-exceptions/{exception_id}

Scopes
risk_exceptions:write
Required header
If-Match

Irreversibly revokes the exception; the record stays with revoked_at and revoked_by.

Parameters

FieldTypeRequired
exception_idpathstring (uuid)yes

Responses

  • 204
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503