Skip to content

PIN

PIN (Personal Identification Number) is a knowledge-based SCA challenge factor. Users create a 4-digit PIN that can be used to verify their identity when accessing SCA-protected endpoints.

All PIN creation and verification requests use JOSE (JWE) encryption to ensure the PIN is never transmitted in plain text. See the SCA over API guide for encryption details.

Operations

Create a PIN

Request

Creates a new PIN factor used to resolve a SCA knowledge challenge type.

The request and response are encrypted using the JOSE framework. Please refer to the SCA over API guide to understand how encryption and decryption work.

Security
UserToken
Path
profileIdinteger, (int64)required

The profile ID.

Headers
Acceptstringrequired
Default:"application/jose+json"
Accept-Encodingstringrequired
Default:"identity"
Content-Encodingstringrequired
Default:"identity"
X-tw-jose-methodstringrequired
Default:"jwe"
X-External-Correlation-Idstring, (uuid), <= 36 characters

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479
Bodyapplication/jose+jsonrequired
string

A JWE encrypted string. The decrypted payload contains:

  • pin — A four-digit string.

Payload before encryption:

{"pin": "1234"}
curl -X POST \
  'https://api.wise-sandbox.com/v2/profiles/{profileId}/pin' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Accept: application/jose+json' \
  -H 'Accept-Encoding: identity' \
  -H 'Content-Type: application/jose+json' \
  -H 'Content-Encoding: identity' \
  -H 'X-tw-jose-method: jwe' \
  -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcx...'

Responses

The PIN has been successfully created.

Headers
X-External-Correlation-Idstring, (uuid), <= 36 characters

Echoed back when X-External-Correlation-Id was included in the request. Learn more.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"
x-trace-idstring

Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.

Example:"fba501b6d453b96789f52338f019341f"
Response
No content