Skip to main content

Suspend or Reinstate an Account

POST 
/client/users/:correlation_id/suspension

Used to suspend an account (SUSPEND) or to reinstate a previously-suspended account (REMOVE, remove the suspension).

Request​

Body​

AttributeDefinitionFormatNotes
actionProvides the action to either suspend or un-suspend an account.StringRequired. Either "SUSPEND" (to suspend account) or "REMOVE" (to remove a SUSPENDED status).
reasonCodeCode that specifies the reason the suspension or the removal of a suspension is taking place.StringRequired. Valid values are: Used with SUSPEND: FRAUDULENT_BEHAVIOUR, SUSPECTED_FRAUD, POLICY_VIOLATION, EXCESS_OR_ABUSE, or OTHER. Used with REMOVE: LEGIT_BEHAVIOUR, ISSUE_RESOLVED, INVEST_INCONCLUSIVE, or OTHER.
reasonUser-friendly version of information about why the action is being taken.StringOptional. Valid values: Used with SUSPEND: Fraudulent Behaviour, Suspected Fraud Behaviour, Policy Violation, Excessive or abusive account behaviour, or Other. Used with REMOVE: Legitimate Behaviour, Issue Resolved, Investigation Inconclusive, or Other.
detailsProvide additional information, up to 1,024 characters, about the action taken.StringOptional

Response​

AttributeDefinitionFormatNotes
messageMessage regarding the outcome of the action to suspend or un-suspend an account.StringFor sucessful SUSPEND action: "The account is successfully suspended."
For successful REMOVE action (remove a suspension): "The account is successfully suspended."

Error Responses​

statusCodeerrorMessageerrorCodeDefinition
400 Bad RequestSuspension action is mandatory and required to be non-emptyMISSING_REQUIRED_FIELDS_ERRORaction either is not included in the request or has no value included.
400 Bad RequestSuspension reasonCode is mandatory and required to be non-emptyMISSING_REQUIRED_FIELDS_ERRORreasonCode either is not included in the request or has no value included.
400 Bad RequestSuspension action must be a valid action.INVALID_ACTIONThe value for action is not valid (not SUSPEND or REMOVE).
400 Bad RequestInvalid reasonCode. Please specify a valid reasonCode.INVALID_REQUESTThe value used for the reasonCode is not valid. See request documentation for valid reasonCodes for SUSPEND and REMOVE.
400 Bad RequestInvalid displayName. Please specify a valid displayName.INVALID_REQUESTreason (the displayName) does not have one of the specified values. To see values, view the documentation for reason in the request.
400 Bad RequestSuspension reasonCode length exceeded.MAX_LENGTH_EXCEEDEDMax length is 20 characters.
400 Bad RequestSuspension reason length exceeded.MAX_LENGTH_EXCEEDEDMax length is 40 characters.
400 Bad RequestDetails length exceeded.MAX_LENGTH_EXCEEDEDMax length is 1024 characters.
400 Bad RequestAccount is already suspended.ACCOUNT_ALREADY_SUSPENDEDAccount already has SUSPEND status.

Request​

Responses​

200 - Account Successfully Suspended

Response Headers
    Date
    Example: Fri, 14 Apr 2023 06:08:08 GMT
    Content-Length
    Example: 53
    Connection
    Example: keep-alive
    x-amzn-RequestId
    Example: ecef19be-a378-42ed-bcf6-258a1320cf66
    Referrer-Policy
    Example: no-referrer
    X-XSS-Protection
    Example: 1;mode=block
    Access-Control-Allow-Origin
    Example: *
    Expect-CT
    Example: max-age=86400
    Strict-Transport-Security
    Example: max-age=31536000; includeSubDomains; preload
    Feature-Policy
    Example: vibrate 'none'; geolocation 'none'
    X-Frame-Options
    Example: sameorigin
    Content-Security-Policy
    Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
    x-amz-apigw-id
    Example: DWoW_HTLIAMFulQ=
    cache-control
    Example: no-cache, no-store, must-revalidate
    X-Content-Type-Options
    Example: nosniff
    X-Amzn-Trace-Id
    Example: Root=1-6438edc6-4638f54f65f0ea8e6b7a035b;Sampled=0;lineage=e5ffa4d6:0
Last updated on