User identification key

Verify anonymous user identification key

post

Verifies whether the anonymous user identification key passed in the x-anon-key header is valid.

Business error code

The errors below are returned with HTTP 200 and resultType: FAIL.

errorCode	Description
4010	Authentication information could not be found.
4095	Request limit exceeded. Please try again later.

Request limit: 3,000 times per minute per app

Authorizations

mutualTLS

This is client-certificate-based mTLS authentication issued to the partner. The mini app is identified by the certificate's CN. Refer to the Use the server API document for how to issue and manage certificates.

Header parameters

x-anon-keystringRequired

It's a key for authenticating users. You can issue it with the User.getAnonymousKey function in the mini app SDK

Example: kQ7pL2mZxN9wRt5vB8yD3jF6cA1

Responses

200

The anonymous user identification key verification result is returned as true or false.

application/json

or

400

Request format is invalid. error.data is an empty object, and error.reason is returned as Unknown Error. Missing the x-anon-key header is not returned in this response, but as an HTTP 200 business error (4010).

application/json

500

This is an unclassified server error. If it keeps failing, please contact the partner support channel.

application/json

post/api-partner/v1/apps-in-toss/users/anon-key/verify

POST /api-partner/v1/apps-in-toss/users/anon-key/verify HTTP/1.1
Host: apps-in-toss-api.toss.im
x-anon-key: {anonKey}

{
  "resultType": "SUCCESS",
  "success": true
}