Get Auth Control

Use the Get Auth Control endpoint to retrieve the velocity control details and their control IDs—at either the account level or product level. If you try to retrieve account-level settings that do not exist, this endpoint returns an error. See Setting Account-Level Authorization Controls for instructions on using this endpoint.

Desired ResultcontrolIdprodIdaccountNo
Get all product-level controls for a product.blankProduct IDblank
Get all account-level controls for an account, including current usages and available balances of controls.blankblankPRN
Get the product-level control details for a particular control ID.Control IDProduct IDblank
Get the account-level control details for a particular control ID, including current usage and available balance of the control.Control IDblankPRN
Recipes
Get Auth Control response for product
Open Recipe
Get Auth Control response for account
Open Recipe

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status CodeCode Description
600-01No account-level auth control has been set for this account
600-02Product is not configured for account-level auth controls.
600-03Calculations on the current usages and available balances of account-level auth controls have failed due to unknown period type of auth controls.
Language
Click Try It! to start a request and see the response here!