POST v1/clients/{id}/create-clientkey

Add new Client Key to Client

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Client Id to add Key to.

 globally unique identifier

Required

Body Parameters

Description of the Key.

ClientKeyAddPostRequest
NameDescriptionTypeAdditional information
Description

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Description": "sample string 1"
}

text/html

Sample: 
{"Description":"sample string 1"}

application/xml, text/xml

Sample: 
<ClientKeyAddPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Models">
  <Description>sample string 1</Description>
</ClientKeyAddPostRequest>

Response Information

Resource Description

New client key, if it exists. Otherwise a 404 error.

ClientKey
NameDescriptionTypeAdditional information
Key

globally unique identifier

None.
Description

string

None.
LastAccessedUtc

date

None.

Response Codes

  • 200 OK: Requested client keys successfully returned.
  • 400 BadRequest: Requested client does not exist.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Key": "09aa2711-cf36-4684-b64d-07cf91591a60",
  "Description": "sample string 2",
  "LastAccessedUtc": "2025-12-11T17:07:48.3880714Z"
}

text/html

Sample: 
{"Key":"09aa2711-cf36-4684-b64d-07cf91591a60","Description":"sample string 2","LastAccessedUtc":"2025-12-11T17:07:48.3880714Z"}

application/xml, text/xml

Sample: 
<ClientKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Models">
  <Description>sample string 2</Description>
  <Key>09aa2711-cf36-4684-b64d-07cf91591a60</Key>
  <LastAccessedUtc>2025-12-11T11:07:48.3880714-06:00</LastAccessedUtc>
</ClientKey>