GET /submission/tokens?tokenId=user001a

{
  "success": true,
  "tokenId": "user001a",
  "data": {
    "tokenId": "user001a",
    "updateTime": "2024-01-15T10:30:45.123Z"
  }
}
Securely retrieve registered tokens. You can perform detailed retrieval of a single token or retrieval of the entire token list.
When the Secure Data Transmission option is enabled, response data is transmitted encrypted with AES-256.

​
Basic Information

​
method
string
required
GET
​
url
string
required
https://rest-api.argosidentity.com/v3/submission/tokens

​
Security Settings

​
Encrypted Transmission

When Secure Data Transmission is enabled, all response data is protected with AES-256 encryption.
  • Encryption method: AES-256
  • Coverage: Response data
  • Compatibility: Same encryption/decryption method as POST/submission, PATCH/submission, DELETE/submission, Webhook
  • Secure Data Transfer Options

​
Authentication

​
x-api-key
string
required
Set your project API key.
x-api-key: {{YOUR_API_KEY}}

​
Token Retrieval Types

  1. Single retrieval
  • Detailed retrieval of specific tokenId (1 per request)
  1. List retrieval
  • Entire token list retrieval: 10,000 per request
  • When registered tokenId exceeds 10,000, pagination fields (‘nextPageKeyId’, ‘nextPageKeyTime’) are provided
  1. Total count retrieval
  • Retrieve total count of registered tokens (entire N count per request)

​
Request Parameters

​
Query Parameters

​
tokenId
String
Specific token ID
  • When provided: Single token detailed retrieval
  • When not provided: Entire token list retrieval
​
type
String
count
  • When provided: Retrieve only the total count of registered tokens
  • When not provided: Provide registered tokens and expiration status and count
GET /submission/tokens?tokenId=user001a

​
Response

​
Success Response (200)

​
success
Boolean
required
Retrieval success status
​
tokenId
String
required
Retrieved token ID
​
data
Object
required
Token data
{
  "success": true,
  "tokenId": "user001a",
  "data": {
    "tokenId": "user001a",
    "updateTime": "2024-01-15T10:30:45.123Z"
  }
}
You can use the data[‘expired’] value to check which tokens have expired among previously submitted ones and utilize it for DELETE-token operations.

​
Error Response (400/500)

​
errorCode
String
required
Error code
​
errorMessage
String
required
Error message
{
  "errorCode": "token_not_found",
  "errorMessage": "Token not found."
}

​
Security Considerations

​
Data Protection

Token retrieval may contain sensitive information. Consider enabling the encryption option for security in production environments.
  • Encrypted transmission: Response data encryption through AES-256
  • Access control: Project-level access restriction through API keys
  • Pre-validation: API retrieval possible regardless of option activation status

​
Token Policy

Token Pool: Manage up to 100,000 tokens per PID Retrieval scope: Can only retrieve tokens within project scope

​
Error Codes

​
Common Errors

Error CodeHTTP StatusDescription
invalid_payload400Missing request payload or format error
invalid_path400Unsupported HTTP method
invalid_project400Missing project ID or invalid API key
invalid_query_parameters400Missing query parameters or format error
invalid_order400Query parameter order format error
internal_server_error500Internal server error
Error CodeHTTP StatusDescription
invalid_token_id400Missing token ID, empty value, or not an array
invalid_token_id_format400Token ID format rule violation
invalid_token_id_type400Token ID is not a string
invalid_token_id_length400Token ID length outside 8-64 character range
invalid_token_id_whitespace400Token ID contains whitespace characters
invalid_token_id_characters400Token ID contains disallowed characters
invalid_token_id_start400Token ID does not start with letter/number
invalid_token_id_end400Token ID does not end with letter/number
request_token_limit_exceeded400Request token count limit exceeded (500)
token_limit_exceeded400Project token total count limit exceeded (100,000)
token_id_not_found400Requested token does not exist in pool
token_id_details_not_found400Token details retrieval failed
delete_token_limit_exceeded400Time-based bulk deletion request count exceeded (5000)

​
Usage Examples

1

Check entire token list

First, retrieve all tokens registered in the project.
curl -X GET 'https://rest-api.argosidentity.com/v3/submission/tokens' \
  -H 'x-api-key: YOUR_API_KEY'
You can check the total token count through the count field in the response.
2

Retrieve specific token details

Retrieve detailed information for a specific token.
curl -X GET 'https://rest-api.argosidentity.com/v3/submission/tokens?tokenId=user001a' \
  -H 'x-api-key: YOUR_API_KEY'
You can check the token’s last update time through updateTime.
In encrypted environments, response data is also provided encrypted.
Decryption processing is required for this data.
For encryption and decryption methods, refer to Data Encryption and Decryption.