Skip to end of banner
Go to start of banner

PIN code change

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Current »

Managing the PIN code

The user may want to change their PIN code.  To facilitate this the client needs to create a request to

PATCH /api/users/v1/users/<userId>

The new PIN code should be supplied in the "new_pin_code" field. 

The API will respond with "400 Bad Request" if the PIN code does not meet the following validation requirements:

  • Numeric
  • Number of digits must be exactly 4

An example of the PATCH request body is as follows:

{
  "pin_code": "1234",
  "new_pin_code": "0789",
}

Note:

  • The API will verify the PIN code supplied against the one stored for the user account and return "403 Forbidden" if an incorrect PIN is supplied
  • No other fields should be supplied; the API will respond with "400 Bad Request" if you try to PATCH anything at the same time as the PIN code
  • No labels