> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt > Use this file to discover all available pages before exploring further. # Get claim key > Get the claim key with the specified uuid. A claim key represents one purchased term: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only claim keys of `type` `NEW` carry a `startDate` - a `RENEWAL` key extends the terms it renews and carries only an `endDate`. ## OpenAPI ````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/license/claimkey/getClaimKey openapi: 3.0.1 info: contact: email: developer@rhombussystems.com description: >- This API is for use by Rhombus customers and partners. ## Authentication All requests require two headers: - `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth. - `x-auth-apikey` — Your Rhombus API key. Example: ``` POST /api/camera/getMinimalCameraStateList x-auth-scheme: api-token x-auth-apikey: YOUR_API_KEY Content-Type: application/json ``` title: Rhombus API version: '1.0' servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/license/claimkey/getClaimKey: post: tags: - ClaimKey Webservice summary: Get claim key description: >- Get the claim key with the specified uuid. A claim key represents one purchased term: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only claim keys of `type` `NEW` carry a `startDate` - a `RENEWAL` key extends the terms it renews and carries only an `endDate`. operationId: getClaimKey parameters: - description: >- Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key. example: api-token in: header name: x-auth-scheme required: true schema: type: string default: api-token enum: - api-token - api - partner-api-token - partner-api requestBody: content: application/json: schema: $ref: '#/components/schemas/License_claimkey_GetClaimKeyWSRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/License_claimkey_GetClaimKeyWSResponse' description: OK components: schemas: License_claimkey_GetClaimKeyWSRequest: type: object properties: uuid: type: string format: RUUID description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA nullable: true License_claimkey_GetClaimKeyWSResponse: type: object properties: claimKey: $ref: '#/components/schemas/BaseClaimKey' error: type: boolean nullable: true errorMsg: type: string nullable: true warningMsg: type: string nullable: true BaseClaimKey: type: object discriminator: propertyName: type properties: claimEndDate: type: string format: date-time description: >- Date/time when claiming of licenses represented by this claim key ended successfully. nullable: true claimStartDate: type: string format: date-time description: >- Date/time when claiming of licenses represented by this claim key started. nullable: true createdOn: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true expirationEmailState: $ref: '#/components/schemas/ClaimKeyExpirationEmailStateEnum' gracePeriodEndDate: type: string format: date-time nullable: true maskedClaimCode: type: string description: >- Masked claim code for redeemed claim keys. This field can be used for reference purposes. nullable: true orgUuid: type: string format: RUUID description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA nullable: true renewedByClaimKeyUuid: type: string format: RUUID description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA nullable: true requestId: type: string description: >- Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys. nullable: true returnHistory: type: array items: $ref: '#/components/schemas/ClaimKeyReturnEvent' nullable: true state: $ref: '#/components/schemas/ClaimKeyStateEnum' trial: type: boolean nullable: true type: $ref: '#/components/schemas/ClaimKeyTypeEnum' updatedOn: type: string format: date-time nullable: true uuid: type: string format: RUUID description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA nullable: true ClaimKeyExpirationEmailStateEnum: type: string enum: - NINETY_DAY_EMAIL_SUCCEEDED - NINETY_DAY_EMAIL_FAILED - SIXTY_DAY_EMAIL_SUCCEEDED - SIXTY_DAY_EMAIL_FAILED - FOURTY_FIVE_DAY_EMAIL_SUCCEEDED - FOURTY_FIVE_DAY_EMAIL_FAILED - THIRTY_DAY_EMAIL_SUCCEEDED - THIRTY_DAY_EMAIL_FAILED - TWENTY_ONE_DAY_EMAIL_SUCCEEDED - TWENTY_ONE_DAY_EMAIL_FAILED - FOURTEEN_DAY_EMAIL_SUCCEEDED - FOURTEEN_DAY_EMAIL_FAILED - TEN_DAY_EMAIL_SUCCEEDED - TEN_DAY_EMAIL_FAILED - FIVE_DAY_EMAIL_SUCCEEDED - FIVE_DAY_EMAIL_FAILED - FOUR_DAY_EMAIL_SUCCEEDED - FOUR_DAY_EMAIL_FAILED - THREE_DAY_EMAIL_SUCCEEDED - THREE_DAY_EMAIL_FAILED - TWO_DAY_EMAIL_SUCCEEDED - TWO_DAY_EMAIL_FAILED - ONE_DAY_EMAIL_SUCCEEDED - ONE_DAY_EMAIL_FAILED - ZERO_DAY_EMAIL_SUCCEEDED - ZERO_DAY_EMAIL_FAILED - GRACE_PERIOD_EMAILS_IN_PROGRESS - GRACE_PERIOD_EMAILS_COMPLETED - UNKNOWN ClaimKeyReturnEvent: type: object properties: returnedProductQuantities: type: object additionalProperties: type: integer format: int32 nullable: true nullable: true timestamp: type: string format: date-time nullable: true ClaimKeyStateEnum: type: string enum: - CREATED - CLAIMING_PENDING - CLAIMING_IN_PROGRESS - CLAIMING_FAILED - CLAIMED - EXPIRED_UNCLAIMED - EXPIRED - RETURNED - RENEWED ClaimKeyTypeEnum: type: string enum: - NEW - RENEWAL securitySchemes: ApiKeyAuth: description: >- Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). in: header name: x-auth-apikey type: apiKey ````