SDK Explorer

Create a challenge to update a user's PIN via existing PIN.

Parameters
input
object
Required

Represents input parameters for managing a user's PIN.

option 1:
userId
string
Required

Unique system-generated identifier for the user.

idempotencyKey
string

The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.

We will generate one if you do not provide it.

option 2:
userToken
string
Required

The JSON Web Token (JWT) representing the user.

idempotencyKey
string

The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.

We will generate one if you do not provide it.

Responses
Example
1const response = await client.updateUserPin({
2  userToken: 'dummy-user-token',
3})
4console.log(response.data?.challengeId)
ResponseChoose an example
1{
2  "data": {
3    "challengeId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5"
4  }
5}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.