Skip to main content
GET
/
api
/
v1
/
credentials
/
{id}
curl --request GET \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/credentials/a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Authorization: Bearer <your_token>'
{
  "message": "Successfully retrieved credential.",
  "data": {
    "credential": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "corporation_id": "550e8400-e29b-41d4-a716-446655440000",
      "portal_id": "PORTAL_CA_CDTFA",
      "credential_type": "INDIRECT_TAX_REGISTRATION",
      "is_custom": false,
      "name": "California CDTFA Portal",
      "status": "ACTIVE",
      "blocks": [
        {
          "id": "block-uuid-1",
          "block_key": "username",
          "block_label": "Username",
          "block_type": "String",
          "value": "user@example.com"
        },
        {
          "id": "block-uuid-2",
          "block_key": "password",
          "block_label": "Password",
          "block_type": "SecureString",
          "value": "my-secure-password"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  }
}
Retrieve the full details of a credential, including its blocks.

Path parameters

id
string
required
The unique identifier (UUID) of the credential.
curl --request GET \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/credentials/a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Authorization: Bearer <your_token>'
{
  "message": "Successfully retrieved credential.",
  "data": {
    "credential": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "corporation_id": "550e8400-e29b-41d4-a716-446655440000",
      "portal_id": "PORTAL_CA_CDTFA",
      "credential_type": "INDIRECT_TAX_REGISTRATION",
      "is_custom": false,
      "name": "California CDTFA Portal",
      "status": "ACTIVE",
      "blocks": [
        {
          "id": "block-uuid-1",
          "block_key": "username",
          "block_label": "Username",
          "block_type": "String",
          "value": "user@example.com"
        },
        {
          "id": "block-uuid-2",
          "block_key": "password",
          "block_label": "Password",
          "block_type": "SecureString",
          "value": "my-secure-password"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  }
}