Get entitlement info

GET 
/api/web/v1/entitlements/info

Get entitlement info. Caller requires the ENTITLEMENTS:VIEW permission.

Responses

200

Successful

application/json

Schema

Schema

idProofing

object

ID Proofing-specific entitlements of a tenant.

billingType stringrequired

Possible values: [PRE_PAID, PAY_PER_USE]

The model used for billing.

consumed int32

Possible values: >= 1 and <= 50000000

The entitlements consumed since start date (percent over quantity for PRE_PAID accounts) or in the current month (PAY_PER_USE accounts).

endDate date-timerequired

The date this entitlement will end in UTC time. The value must be after the start date.

faceRecognitionType string

Possible values: [ENHANCED, STANDARD]

The face recognitation type licensed.

quantity int32

Possible values: >= 1 and <= 50000000

The number of entitlements assigned to the tenant (required during creation if billingType is PRE_PAID).

startDate date-timerequired

The date this entitlement will start in UTC time.

smsVoice

object

Sms/Voice entitlements of a tenant.

allotment int32

The number of entitlements allotted to the current account. If the account is an SP then entitlements can be allocated to child accounts.

consumed int32

The entitlements consumed since start date during the entitlement period.

endDate date-time

The date when the entitlement will end.

quantity int32

The number of SMS/Voice credits allowed during the period.

renewalQuantity int32

The number of SMS/Voice credits allowed when the entitlement is renewed.

startDate date-time

The date when the entitlement starts.

users

object

User entitlements of a tenant.

allotment int32

The number of entitlements allotted to the current account. If the account is an SP then entitlements can be allocated to child accounts. For subscriber accounts, the allotment is always the same as the quantity amount.

consumed int32

The used quantity of this entitlement.

endDate date-time

The date when the entitlement ends.

quantity int32

The quantity of entitlements purchased for the account.

startDate date-time

The date when the entitlement starts.

Example (from schema)

{
  "idProofing": {
    "billingType": "PRE_PAID",
    "consumed": 0,
    "endDate": "2020-02-18T23:59:59Z",
    "faceRecognitionType": "ENHANCED",
    "quantity": 0,
    "startDate": "2019-02-19T00:00:00Z"
  },
  "smsVoice": {
    "allotment": 400,
    "consumed": 0,
    "endDate": "2020-02-19T00:00:00Z",
    "quantity": 1000,
    "renewalQuantity": 1000,
    "startDate": "2019-02-19T00:00:00Z"
  },
  "users": {
    "allotment": 130,
    "consumed": 37,
    "endDate": "2020-02-18T23:59:59Z",
    "quantity": 200,
    "startDate": "2019-02-19T00:00:00Z"
  }
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...