POST/Token

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"
  ]
}'

{
  "tokenId": [
    "user001a",
    "api.key.01", 
    "token-123-abc",
    "session_data_01"
  ]
}

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

{
  "success": false,
  "message": "Some tokens failed to process",
  "summary": {
    "totalSubmitted": 4,
    "currentCount" : 3504,
    "processed": 3,
    "failed": 1
  },
  "details": {
    "failed": [
      {
        "tokenId": "token-123-abc",
        "error": "Process_failed",
        "message": "Write operation failed"
      }
    ]
  }
}

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

string

required

POST

string

required

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

For KR region projects, replace the host with kr.rest-api.argosidentity.com. See Regions for details.

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

string

required

Set your project API key.

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

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 -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"
  ]
}'

{
  "tokenId": [
    "user001a",
    "api.key.01", 
    "token-123-abc",
    "session_data_01"
  ]
}

Response

Success Response (200)

Boolean

Operation success status

String

Operation result message

Object

Summary information

Show summary properties

Number

Total number of tokens submitted

Number

Total number of currently registered tokens

Number

Number of tokens successfully processed

Number

Number of failed tokens

Object

Detailed information (included only when failures occur)

Show details properties

Array

List of failed tokens

Show failed array properties

String

Failed token ID

String

Failure code

String

Failure message

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

{
  "success": false,
  "message": "Some tokens failed to process",
  "summary": {
    "totalSubmitted": 4,
    "currentCount" : 3504,
    "processed": 3,
    "failed": 1
  },
  "details": {
    "failed": [
      {
        "tokenId": "token-123-abc",
        "error": "Process_failed",
        "message": "Write operation failed"
      }
    ]
  }
}

Error Response (400/500)

String

required

Error code

String

required

Error message

Object

Error details (optional)

{
  "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

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 Query String Usage: https://form.argosidentity.com?pid={projectid}&token={tokenid_POSTed}

The Liveform URLs on this page are for US region projects. KR region projects use the host form-kr.argosidentity.com. See Regions for details.

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

Query String and Token Guide

A comprehensive guide to the query string and Token ID options for Liveform. These options enable features such as transmitting additional information, preventing duplicate submissions, and identifying users. Explore essential tools to optimize your ID check process.

Token expired

This event is triggered when a Token ID expires according to the configured expiration conditions. You can manage tokens based on usage count or time through Token Expiration settings, and webhooks are automatically sent when tokens expire. This allows you to track token lifecycle and prevent token reuse issues.

⌘I

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"
  ]
}'

{
  "tokenId": [
    "user001a",
    "api.key.01", 
    "token-123-abc",
    "session_data_01"
  ]
}

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

{
  "success": false,
  "message": "Some tokens failed to process",
  "summary": {
    "totalSubmitted": 4,
    "currentCount" : 3504,
    "processed": 3,
    "failed": 1
  },
  "details": {
    "failed": [
      {
        "tokenId": "token-123-abc",
        "error": "Process_failed",
        "message": "Write operation failed"
      }
    ]
  }
}

Overview

API Reference

Basic Information

Security Settings

Encryption Option

Authentication

Request Parameters

Request Body

Response

Success Response (200)

Error Response (400/500)

Token Policy

Limitations

Partial Handling

Error Codes

Common Errors

Query String and Token Guide

Token expired

​Basic Information

​Security Settings

​Encryption Option

​Authentication

​Request Parameters

​Request Body

​Response

​Success Response (200)

​Error Response (400/500)

​Token Policy

​Limitations

​Partial Handling

​Error Codes

​Common Errors

​Token Related Errors

​Related documents

Query String and Token Guide

Token expired

Basic Information

Security Settings

Encryption Option

Authentication

Request Parameters

Request Body

Response

Success Response (200)

Error Response (400/500)

Token Policy

Limitations

Partial Handling

Error Codes

Common Errors

Token Related Errors

Related documents