GET/Token

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

string

required

GET

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

string

required

Set your project API key.

x-api-key: {{YOUR_API_KEY}}

Token Retrieval Types

Single retrieval

Detailed retrieval of specific tokenId (1 per request)

List retrieval

Entire token list retrieval: 10,000 per request
When registered tokenId exceeds 10,000, pagination fields (‘nextPageKeyId’, ‘nextPageKeyTime’) are provided

Total count retrieval

Retrieve total count of registered tokens (entire N count per request)

Request Parameters

Query Parameters

String

Specific token ID

When provided: Single token detailed retrieval
When not provided: Entire token list retrieval

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

GET /submission/tokens

GET /submission/tokens?type=count

Response

Success Response (200)

Single token retrieval
Entire list retrieval
Total count retrieval

Boolean

required

Retrieval success status

String

required

Retrieved token ID

Object

required

Token data

Show data properties

String

Token ID

String

Last update time (ISO 8601 format)

Boolean

[true, false]

{
  "success": true,
  "tokenId": "user001a",
  "data": {
    "tokenId": "user001a",
    "updateTime": "2024-01-15T10:30:45.123Z"
  }
}

Boolean

required

Retrieval success status

Array<String>

required

Token ID list

Array<Object>

required

Token data array

Show data array properties

String

Token ID

String

Last update time (ISO 8601 format)

Boolean

[true, false]

Number

required

Total token count

Object

required

Pagination key object

Show nextPageKey array properties

String

Pagination key Id

String

Pagination key Time

{
  "success": true,
  "tokenId": ["user001a", "api.key.01", "token-123-abc"],
  "data": [
    {
      "tokenId": "user001a",
      "updateTime": "2024-01-15T10:30:45.123Z"
    },
    {
      "tokenId": "api.key.01",
      "updateTime": "2024-01-15T09:15:30.456Z"
    },
    {
      "tokenId": "token-123-abc",
      "updateTime": "2024-01-15T08:45:12.789Z"
    }
  ],
  "count": 3,
	"nextPageKey" : {
	  "id": "sample.id.01",
	  "time": "2024-01-15T08:45:12.792Z"
	}
}

Boolean

required

Retrieval success status

Number

required

Total count of registered tokens

{
  "success": true,
  "totalCount": 4991
}

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)

String

required

Error code

String

required

Error message

{
  "errorCode": "token_not_found",
  "errorMessage": "Token not found."
}

{
  "errorCode": "token_id_details_not_found", 
  "errorMessage": "Token details could not be retrieved."
}

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 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)

Usage Examples

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.

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.

Overview

API Reference

Basic Information

Security Settings

Encrypted Transmission

Authentication

Token Retrieval Types

Request Parameters

Query Parameters

Response

Success Response (200)

Error Response (400/500)

Security Considerations

Data Protection

Token Policy

Error Codes

Common Errors

Usage Examples

​Basic Information

​Security Settings

​Encrypted Transmission

​Authentication

​Token Retrieval Types

​Request Parameters

​Query Parameters

​Response

​Success Response (200)

​Error Response (400/500)

​Security Considerations

​Data Protection

​Token Policy

​Error Codes

​Common Errors

​Token Related Errors

​Usage Examples

Basic Information

Security Settings

Encrypted Transmission

Authentication

Token Retrieval Types

Request Parameters

Query Parameters

Response

Success Response (200)

Error Response (400/500)

Security Considerations

Data Protection

Token Policy

Error Codes

Common Errors

Token Related Errors

Usage Examples