Error
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"scope": "openid credentials.read credentials.verify",
"publicKey": "<string>",
"nickname": "<string>",
"partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "INVALID_PARAMETER",
"message": "scope is required"
}{
"code": "INVALID_TOKEN",
"message": "Unknown agent API key"
}{
"code": "AGENT_KEYS_DISABLED",
"message": "Agent keys are not enabled for this partner"
}{
"code": "INVALID_PARAMETER",
"message": "<string>"
}Agent APIs
Update an agent nickname
Letters, numbers, spaces, hyphens, and colons; maximum 32 characters. An
empty string clears the nickname. Does not require x-partner-jwt.
PATCH
/
v2
/
auth
/
agent
/
keys
/
partner
/
{id}
Error
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"scope": "openid credentials.read credentials.verify",
"publicKey": "<string>",
"nickname": "<string>",
"partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "INVALID_PARAMETER",
"message": "scope is required"
}{
"code": "INVALID_TOKEN",
"message": "Unknown agent API key"
}{
"code": "AGENT_KEYS_DISABLED",
"message": "Agent keys are not enabled for this partner"
}{
"code": "INVALID_PARAMETER",
"message": "<string>"
}Authorizations
The holder's AIR Kit partner access token, from airService.getAccessToken().
Send it with x-partner-id.
Headers
Your Partner ID (UUID) from the Developer Dashboard.
Path Parameters
Agent key UUID from bind or list.
Body
application/json
Display name (letters, numbers, spaces, hyphens, colons; maximum 32 characters), or an empty string to clear it.
Maximum string length:
32Example:
"KYC reader"
Response
Updated key (no agentApiKey)
Space-delimited scopes granted to the key, including openid.
Example:
"openid credentials.read credentials.verify"
Masked PEM when a public key was bound; null for API-key-only agents.
Was this page helpful?