Skip to main content

ClaimType

The type of the claim, providing validation of the claim value.

enum ClaimType {
  boolean
  date
  dateTime
  email
  image
  list
  number
  phone
  regex
  text
  url
}

Values​

ClaimType.boolean​

The claim value is a boolean value encoded as true or false.

ClaimType.date​

The claim value is a date string in full-date ISO 8601 format: YYYY-MM-DD.

ClaimType.dateTime​

The claim value is a date-time string in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ClaimType.email​

The claim value is an email address.

ClaimType.image​

The claim value is a JPEG image encoded as a base64 encoded data URL.

ClaimType.list​

The claim value is one of a list of strings specified via the claim validation field.

ClaimType.number​

The claim value is a numeric type, supporting both integers and decimals (encoded as a string).

ClaimType.phone​

The claim value is a phone number in international E.164 format.

ClaimType.regex​

The claim value matches a regex pattern.

ClaimType.text​

The claim value is text.

ClaimType.url​

The claim value is a URL.

Member Of​

ContractDisplayClaim object ● ContractDisplayClaimInput input ● CreateUpdateTemplateDisplayClaimInput input ● TemplateDisplayClaim object