POST/Token

Secure token registration API guide with private mode and encryption settings

Securely register tokens. You can register up to 100,000 tokens per project, with a maximum of 500 tokens per request.

You can transmit data securely through private mode and encryption security features.

Basic Information

method · string · required

POST

url · string · required

https://rest-api.argosidentity.com/v3/submission/tokens

Security Settings

Encryption Option

When the Secure Data Transmission option is enabled, requests and responses are encrypted with AES-256.

• Encryption method: AES-256
• Coverage: Request and response data
• Compatibility: Same encryption/decryption method as POST/submission, PATCH/submission, GET/submission
• Secure Data Transfer Options

Authentication

x-api-key · string · required

Set your project API key.

Content-Type · string · required

Set the MIME type of the request body.

When using Content-Type: application/json for POST requests, if the request fails, use text/plain instead.

x-api-key: {{YOUR_API_KEY}}
Content-Type: text/plain

Request Parameters

Request Body

tokenId · Array<String> · required

Array of token IDs to add (maximum 500 per request)

Token ID format constraints:

• Length: 8 Byte ~ 64 Byte
• Allowed characters: Letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (_), periods (.)
• Restrictions: No spaces, tabs, or newline characters
• Start/End: Must start and end with letters or numbers only

cURL Request Example

curl -X POST 'https://rest-api.argosidentity.com/v3/submission/tokens' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: text/plain' \
  -d '{
  "tokenId": [
    "user001a",
    "api.key.01", 
    "token-123-abc",
    "session_data_01"
  ]
}'

Response

Success Response (200)

success · Boolean

Operation success status

message · String

Operation result message

summary · Object

Summary information

Show summary properties

totalSubmitted · Number

Total number of tokens submitted

currentCount · Number

Total number of currently registered tokens

processed · Number

Number of tokens successfully processed

failed · Number

Number of failed tokens

details · Object

Detailed information (included only when failures occur)

Show details properties

failed · Array

List of failed tokens

Show failed array properties

tokenId · String

Failed token ID

error · String

Failure code

message · String

Failure message

Complete Success

{
  "success": true,
  "message": "All tokens are now in the pool",
  "summary": {
    "totalSubmitted": 4,
    "currentCount" : 3504,
    "processed": 4,
    "failed": 0
  }
}

Error Response (400/500)

errorCode · String · required

Error code

errorMessage · String · required

Error message

errorDetails · Object

Error details (optional)

Token Format Error

{
  "errorCode": "invalid_token_id_format",
  "errorMessage": "One or more token IDs do not meet the required format specifications.",
  "errorDetails": {
    "invalidTokens": [
      {
        "tokenId": "short01",
        "errorCode": "invalid_token_id_length",
        "errorMessage": "Token ID length must be between 8 and 64 characters. Please adjust the token length."
      }
    ]
  }
}

Token Policy

Limitations

Token Pool: Maximum 100,000 per PID (error occurs when exceeded) Per Request: Maximum 500 token IDs

Important: An error will occur when the token pool exceeds 100,000. To manage token count, you can utilize the following two methods:

• Use the DELETE Token Deletion API to clean up unnecessary tokens in advance.
• Enable the ‘Token Id deletion condition setting’ in the dashboard private mode settings for automatic deletion when tokens expire; used tokens are automatically deleted.

Partial Handling

POST requests are processed partially for token IDs. Token IDs that already exist in the pool will be overwritten, and no separate duplication error is returned.

Example:

• Token IDs existing in pool: tokenA, tokenB, tokenC
• POST request: tokenA, tokenC, tokenD
• Pool after request completion: tokenA, tokenB, tokenC, tokenD

Error Codes

Common Errors

Error Code	HTTP Status	Description
invalid_payload	400	Missing request payload or format error
invalid_path	400	Unsupported HTTP method
invalid_project	400	Missing project ID or invalid API key
invalid_query_parameters	400	Missing query parameters or format error
invalid_order	400	Query parameter order format error
internal_server_error	500	Internal server error

Token Related Errors

Error Code	HTTP Status	Description
invalid_token_id	400	Missing token ID, empty value, or not an array
invalid_token_id_format	400	Token ID format rule violation
invalid_token_id_type	400	Token ID is not a string
invalid_token_id_length	400	Token ID length outside 8-64 character range
invalid_token_id_whitespace	400	Token ID contains whitespace characters
invalid_token_id_characters	400	Token ID contains disallowed characters
invalid_token_id_start	400	Token ID does not start with letter/number
invalid_token_id_end	400	Token ID does not end with letter/number
request_token_limit_exceeded	400	Request token count limit exceeded (500)
token_limit_exceeded	400	Project token total count limit exceeded (100,000)
token_id_not_found	400	Requested token does not exist in pool
token_id_details_not_found	400	Token details retrieval failed
delete_token_limit_exceeded	400	Time-based bulk deletion request count exceeded (5000)

You can securely transmit sensitive token data through encryption settings. Consider enabling the encryption option for security in production environments.

Liveform QueryString Usage: https://form.argosidentity.com?pid={projectid}&token={tokenid_POSTed}

Content-Type Notice: For POST requests, when using Content-Type: application/json causes an error, set the header to text/plain instead.