v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
sca-pin

Verify a PIN

Verifies a PIN challenge when calling a SCA-secured endpoint. Make sure to create a PIN before using this endpoint.

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.

post/v2/profiles/{profileId}/pin/verify

Path parameters

profileIdinteger required

The profile ID.

Headers

One-Time-Tokenstring uuid required

A one-time token unique identifier.

Acceptstring required
Accept-Encodingstring required
Content-Encodingstring required
X-tw-jose-methodstring required
X-External-Correlation-Idstring uuid

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

Response

The PIN has been successfully verified.

oneTimeTokenstring uuid

A one-time token unique identifier.

validityinteger

The One-Time Token expiration in seconds.

Example response

{
  "oneTimeToken": "5932d5b5-ec13-452f-8688-308feade7834",
  "challenges": [
    {
      "primaryChallenge": {
        "type": "PIN"
      }
    }
  ],
  "validity": 3600
}