Developers can use the HYPR Passwordless API to integrate their own applications with the HYPR platform. Standard REST server endpoints are available to perform device registrations, authenticate logins, manage users, configure RP Applications, review the audit trail, and handle administrative tasks.
\nFor all the HYPR Passwordless API endpoints described in this documentation, replace the base {{baseUrl}} placeholder with the URL of your HYPR Server. For example:
{{baseUrl}}/rp/api/versioned/recoverypin/retrieve
becomes
\nhttps://highlandsbank.hypr.com/rp/api/versioned/recoverypin/retrieve
The HYPR Passwordless API can use Bearer or OAuth authentication, so you'll need to send a HYPR-supplied access token in the Authorization header when making requests. For example, in cURL:
\n--header 'Authorization: {{vault:bearer-token}}'
You can generate these access tokens in the HYPR Control Center as described here.
\nNote that most HYPR API requests use an access token issued for a specific RP Application. However, some API requests require an admin-level access token created under the special Control Center Admin RP Application. We recommend using Environment variables in Postman, giving them intuitive labels, and flagging them as secret before saving the Environment. For example:
\n{{token-ccadmin}} for rpAppId/appId controlCenterAdmin
\n{{token-hyprdefaultweb}} for rpAppId/appId HYPRDefaultApplication
\n{{token-hyprdefaultws}} for rpAppId/appId HYPRDefaultWorkstationApplication
\nBearer access tokens generated through the Control Center have an expiration period (TTL) of 30 days. Note that the expiration date is reset to the current date+TTL each time you use the token, so if you access the API at least once a month the token won't expire. If you don't use the token for more than 30 days, it will expire and you'll need to generate a new one.
\nOAuth tokens generated through the Control Center have a default expiration period (TTL) of 1 hour (3599 seconds); this duration is set when the token is created.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20355028","collectionId":"9ba3b65e-a89b-4438-b01c-12d02f954de9","publishedId":"2sA3kPqQAt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3d17b1"},"publishDate":"2024-07-15T15:21:00.000Z"},"item":[{"name":"Control Center","item":[{"name":"Proxy Server","item":[{"name":"Retrieve proxy server settings.","id":"56292448-9597-4879-8eef-eaf3fde6b949","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{baseUrl}}/cc/api/versioned/serverconfig/proxy","description":"Retrieve the proxy settings used to route traffic through a proxy for Firebase PUSH.
\nThis call only works using the controlCenterAdmin Bearer Token.
\nAdded in HYPR version 3.8.0.
\n200 OK
{\n \"proxies\": [\n {\n \"protocol\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": \"<string>\",\n \"user\": \"<string>\",\n \"pass\": \"<string>\"\n }\n ]\n}\n\nprotocol
The protocol used to communicate with the proxy.
[ http | https ]
host
The host where the proxy is running, without https://.
port
The port on which the proxy is running.
user
The username required for login on the proxy.
pass
The (redacted) password required for login on the proxy.
Create the proxy settings used to communicate to PUSH services for out-of-band (OOB) authentication. The proxy settings are needed only if the server does not directly access the Firebase service.
\nThis call only works using the controlCenterAdmin Bearer Token.
\nAdded in HYPR version 3.8.0.
\n200 OK
protocol
The protocol used to communicate with the proxy.
[ http | https ]
host
The host where the proxy is running.
port
The port on which the proxy is running.
user
The username required for login on the proxy.
pass
The password required for login on the proxy
There is no Response Body; the Status Code determines success or failure.
\nTest whether traffic can be routed from the HYPR Server to a test URL via the Proxy Server.
\nThis call only works using the controlCenterAdmin Bearer Token.
\nAdded in HYPR version 3.8.0.
\n200 OK
protocol
The protocol used to communicate with the proxy.
[ http | https ]
host
The host where the proxy is running.
port
The port on which the proxy is running.
user
The username required for login on the proxy.
pass
The password required for login on the proxy.
[\n {\n \"testURL\": \"string\",\n \"configValid\": boolean,\n \"serviceResponse\": \"string\",\n \"errorMsg\": \"string\"\n }\n]\n\ntestURL
The URL to try to reach via the proxy server, hardcoded to https://google.com.
configValid
A flag which indicates success or failure in routing traffic through the proxy server.
serviceResponse
The HTML page received from testURL if traffic was successfully routed through the proxy server to testURL. If configValid is false, then serviceResponse is null.
errorMsg
The error message received if traffic could not be routed successfully through the proxy server to testURL. if configValid is true, then errorMsg is null.
Create/update, view, and test proxy server values.
\nSee the article in our Product Documentation for a full description of Proxy Server functionality.
\n","_postman_id":"9d75b877-9522-4679-be51-2140059603c6","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Certificates","item":[{"name":"List all domain certificates.","id":"2a98083f-3b56-4a34-b62e-31022203e6ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/rp/api/domaincertificate","description":"Retrieve a JSON list of all domain certificates. If the
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.4.0.
\n200 OK
Indicates success.
domainCertificate
The contents of the certificate.
[\n {\n \"domainCertificate\": \"\"\n },\n {\n ...\n }\n]\n\ndomainCertificate
The contents of the certificate.
Add a domain certificate to Control Center.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.4.0.
\n204 No Content
Indicates success.
400 Bad Request
Can indicate a problem with the certificate.
domainCertificate
The contents of the certificate.
There is no response for success except the Status Code above.
\nRemove a domain certificate from Control Center.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.4.0.
\n204 No Content
Indicates success.
domainCertificate
The contents of the certificate.
There is no response for success except the Status Code above.
\nCalls governing domain certificates.
\n","_postman_id":"45982b19-0a6f-4201-a5db-24eaa2992be0","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Adapt","item":[{"name":"Event (Signal) Handlers","item":[{"name":"List all Event handlers for the tenant.","id":"f94b8372-f7f4-443f-a82f-f1961b9664b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/integrations/adapt/eventhandler","description":"List all Event handlers for the tenant.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates success.
The Request Body is empty.
\n[\n {\n \"id\": \"<string>\",\n \"tenantUuid\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"version\": <long> ,\n \"weight\": <integer>,\n \"type\": \"<string>\",\n \"contentType\": \"<string>\",\n \"content\": \"<string>\",\n \"status\": \"<string>\",\n \"hyprManaged\": <boolean>,\n \"configuration\": { \"<string>\" },\n \"configurationMetadata\": { \"<string>\"},\n \"cronSchedule\": \"<string>\",\n \"createdAt\": <datetime>,\n \"createdBy\": \"<string>\"\n },\n {\n ...\n }\n]\n\nid
The unique identifier for the handler.
tenantUuid
The universal unique identifier for the tenant.
name
The handler name.
description
A description for the handler.
version
A date-formatted version for the handler.
weight
The priority given to this policy; higher values mean higher priority.
type
The type of handler.
[ ACTION_EXECUTOR | DATA_COLLECTOR | EVENT_ENRICHER ]
contentType
Is the content BUILT_IN or CUSTOM?
content
The actual code for the handler.
status
Is the handler currently ACTIVE or DISABLED?
hyprManaged
Boolean value indicating whether or not the handler is managed by HYPR.
[ true | false ]
configuration
A map of key/value pairs containing runtime configuration values for the handler. These attributes can be retrieved by the handler code via the ctx.getConfig() call.
Adapt will treat a key as sensitive if the name:
\ncontains ‘key’
\ncontains ‘secret’
\ncontains ‘token'
\nbegins with ‘pass’
\nSecrets in configuration can be saved via the UI, but they will not be returned to the UI on the read calls. Instead, a string will be returned. Handler authors should name secret keys with one of these, to avoid leaks on the admin UI.
\nActual secret values will still be available to the handler at runtime.
\nconfigurationMetadata
Additional key/value pairs affecting the configuration.
cronSchedule
Only used if type is set to DATA_COLLECTOR. If used, the handler will fire an action event at the scheduled time; the handler responds to the action event.
The action event is named based on the handler name. Pseudocode:
\nhandlerName.upppercase().replace(\" \", \"-\").replace(\"_\", \"-\").append(\"_TRIGGER\")
For example: the trigger event name for a handler named my handler is MY_HANDLER_TRIGGER.
\ncreatedAt
The Epoch timestamp when this handler was created.
createdBy
The HYPR username who created the handler.
Get Event handlers for the tenant and event handler Id
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.4.0.
\n200 OK
Indicates success.
The Request Body is empty.
\n[\n {\n \"id\": \"<string>\",\n \"tenantUuid\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"version\": <long> ,\n \"weight\": <integer>,\n \"type\": \"<string>\",\n \"contentType\": \"<string>\",\n \"content\": \"<string>\",\n \"status\": \"<string>\",\n \"hyprManaged\": <boolean>,\n \"configuration\": { \"<string>\" },\n \"configurationMetadata\": { \"<string>\"},\n \"cronSchedule\": \"<string>\",\n \"createdAt\": <datetime>,\n \"createdBy\": \"<string>\",\n \"allVersions\": [\n {\n \"version\": \"<long>\",\n \"createdAt\": <datetime>\n }\n ]\n },\n {\n ...\n }\n]\n\nid
The unique identifier for the handler.
tenantUuid
The universal unique identifier for the tenant.
name
The handler name.
description
A description for the handler.
version
A date-formatted version for the handler.
weight
The priority given to this policy; higher values mean higher priority.
type
The type of handler.
[ ACTION_EXECUTOR | DATA_COLLECTOR | EVENT_ENRICHER ]
contentType
Is the content BUILT_IN or CUSTOM?
content The actual code for the handler.
\nstatus
Is the handler currently ACTIVE or DISABLED?
hyprManaged
Boolean value indicating whether or not the handler is managed by HYPR.
[ true | false ]
configuration
A map of key/value pairs containing runtime configuration values for the handler. These attributes can be retrieved by the handler code via the ctx.getConfig() call.
Adapt will treat a key as sensitive if the name:
\ncontains ‘key’
\ncontains ‘secret’
\ncontains ‘token'
\nbegins with ‘pass’
\nSecrets in configuration can be saved via the UI, but they will not be returned to the UI on the read calls. Instead, a string will be returned. Handler authors should name secret keys with one of these, to avoid leaks on the admin UI.
\nActual secret values will still be available to the handler at runtime.
\nconfigurationMetadata
Additional key/value pairs affecting the configuration.
cronSchedule
Only used if type is set to DATA_COLLECTOR. If used, the handler will fire an action signal at the scheduled time; the handler responds to the action signal.
The action event is named based on the handler name. Pseudocode:
\nhandlerName.upppercase().replace(\" \", \"-\").replace(\"_\", \"-\").append(\"_TRIGGER\")
For example: The trigger signal name for a handler named my handler is MY_HANDLER_TRIGGER.
\ncreatedAt
The Epoch timestamp when this handler was created.
createdBy
The HYPR username who created the handler.
allVersions
List of all versions available for this handler.
Get Event handlers for the tenantUuid, eventHandlerId, and version.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.4.0.
\n200 OK
Indicates success.
The Request Body is empty.
\n[\n {\n \"id\": \"<string>\",\n \"tenantUuid\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"version\": <long> ,\n \"weight\": <integer>,\n \"type\": \"<string>\",\n \"contentType\": \"<string>\",\n \"content\": \"<string>\",\n \"status\": \"<string>\",\n \"hyprManaged\": <boolean>,\n \"configuration\": { \"<string>\" },\n \"configurationMetadata\": { \"<string>\"},\n \"cronSchedule\": \"<string>\",\n \"createdAt\": <datetime>,\n \"createdBy\": \"<string>\",\n \"allVersions\": []\n },\n {\n ...\n }\n]\n\nid
The unique identifier for the handler.
tenantUuid
The universal unique identifier for the tenant.
name
The handler name.
description
A description for the handler.
version
A date-formatted version for the handler.
weight
The priority given to this policy; higher values mean higher priority.
type
The type of handler.
[ ACTION_EXECUTOR | DATA_COLLECTOR | EVENT_ENRICHER ]
contentType
Is the content BUILT_IN or CUSTOM?
content The actual code for the handler.
\nstatus
Is the handler currently ACTIVE or DISABLED?
hyprManaged
Boolean value indicating whether or not the handler is managed by HYPR.
[ true | false ]
configuration
A map of key/value pairs containing runtime configuration values for the handler. These attributes can be retrieved by the handler code via the ctx.getConfig() call.
Adapt will treat a key as sensitive if the name:
\ncontains ‘key’
\ncontains ‘secret’
\ncontains ‘token'
\nbegins with ‘pass’
\nSecrets in configuration can be saved via the UI, but they will not be returned to the UI on the read calls. Instead, a string will be returned. Signal handler authors should name secret keys with one of these, to avoid leaks on the admin UI.
\nActual secret values will still be available to the handler at runtime.
\nconfigurationMetadata
Additional key/value pairs affecting the configuration.
cronSchedule
Only used if type is set to DATA_COLLECTOR. If used, the handler will fire an action signal at the scheduled time; the handler responds to the action signal.
The action signal is named based on the Signal Handler name. Pseudocode:
\nhandlerName.upppercase().replace(\" \", \"-\").replace(\"_\", \"-\").append(\"_TRIGGER\")
For example: the trigger signal name for a Signal Handler named my handler is MY_HANDLER_TRIGGER.
\ncreatedAt
The Epoch timestamp when this handler was created.
createdBy
The HYPR username who created the handler.
allVersions
Empty array, since the result is for a given version already.
Create a new Event Handler for the tenant using minimal attributes. After completing this call, use the PATCH call to update the handler more thoroughly.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates Success
name
The human-readable name for the handler.
content
Base64 JavaScript code to be run for this handler. Without the encoding the request will trip API security scanners.
description
A description of the handler.
status
Is the handler ACTIVE or DISABLED?
weight
The priority given to this policy; higher values mean higher priority.
configuration
A map of key/value pairs containing runtime configuration values for the handler. These attributes can be retrieved by the handler code via the ctx.getConfig() call.
Adapt will treat a key as sensitive if the name:
\ncontains ‘key’
\ncontains ‘secret’
\ncontains ‘token'
\nbegins with ‘pass’
\nSecrets in configuration can be saved via the UI, but they will not be returned to the UI on the read calls. Instead, a string will be returned. Handler authors should name secret keys with one of these, to avoid leaks on the admin UI.
\nActual secret values will still be available to the handler at runtime.
\n{\n \"eventHandlerId\": \"<string>\",\n \"version\": <long>,\n \"lambdaRequestId\": \"<string>\"\n}\n\neventHandlerId
The unique identifier assigned to the handler.
version
A date-formatted version for the handler.
lambdaRequestId
A trace identifier used to determine the specific invocation run by this API call.
Test a Handler Event by submitting test data values.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates success.
message
An array containing test data.
id: A unique identifier for the Event.
\nversion: The API version.
\ntype: Event classification. For API log requests, this will always be AUDIT.
eventName: The name of the Event to be handled.
\nmessage: The test Event to send.
\neventLoggedBy: The origin of the Event. [ BROWSER | CONTROL_CENTER_SERVER | ENROLLMENT_SERVICE | MOBILE_DEVICE | RELYING_PARTY_SERVER | UAF_SERVER | WEB | WORKSTATION ]
eventTimeInUTC: Epoch timestamp for the Signal.
\nloggedTimeInUTC: Epoch timestamp when the Signal was logged.
\ntraceId: A unique identifier used in troubleshooting.
\nadditionalDetails: Additional attributes to be included in the payload.
\nrpAppId: The camel case unique RP Application identifier.
\nmachineUserName: The unique name of the machine in use.
\nserverRelVersion: The server release version.
\norigin: A placeholder value for location data.
\neventTags: A cetegory for the Signal, as described in Event Descriptions.
\nisSuccessful: Boolean value indicating the success or failure of the test. [ true | false ]
{\n \"result\": {\n \"id\": \"<long>\",\n \"version\": <integer>,\n \"type\": \"<string>\",\n \"eventName\": \"<string>\",\n \"message\": \"<string>\",\n \"eventLoggedBy\": \"<string>\",\n \"eventTimeInUTC\": <datetime>,\n \"loggedTimeInUTC\": <datetime>,\n \"traceId\": \"<string>\",\n \"additionalDetails\": { \"<string>\" },\n \"rpAppId\": \"<string>\",\n \"machineUserName\": \"<string>\",\n \"serverRelVersion\": \"<string>\",\n \"origin\": \"<string>\",\n \"eventTags\": \"<string>\",\n \"isSuccessful\": <boolean>,\n \"tenantUuid\": \"<string>\",\n \"txtSent\": <boolean>,\n \"response\": \"{\\\"headers\\\":{\\\":status\\\":[\\\"302\\\"],\\\"cache-control\\\":[\\\"no-store\\\"],\\\"content-length\\\":[\\\"0\\\"],\\\"content-security-policy\\\":[\\\"frame-ancestors 'self';\\\"],\\\"date\\\":[\\\"Thu, 26 Oct 2023 21:03:25 GMT\\\"],\\\"expires\\\":[\\\"0\\\"],\\\"location\\\":[\\\"https://bfluentdev.dev.hypr.com/accessDenied\\\"],\\\"pragma\\\":[\\\"no-cache\\\"],\\\"set-cookie\\\":[\\\"SESSION=YjI5YmVjMTAtZjYzNi00MTQxLWFjNzQtZDQ5NDczZTk4YTQ2; Path=/; Secure; HttpOnly; SameSite=Lax\\\"],\\\"strict-transport-security\\\":[\\\"max-age=31536000; includeSubDomains\\\"],\\\"x-content-type-options\\\":[\\\"nosniff\\\"],\\\"x-frame-options\\\":[\\\"sameorigin\\\"],\\\"x-xss-protection\\\":[\\\"1; mode=block\\\"]},\\\"statusCode\\\":302,\\\"body\\\":\\\"\\\"}\",\n \"source\": \"<string>\",\n \"TenantUuidEntityNameOrId\": \"<string>\",\n \"EventTimeRandomNonce\": <long>\n },\n \"logs\": [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n} \n\nresult
An array containing test results data mimicking the attributes in the Request Body.
logs
A list of log entries associated with the Signal: severity, which will be one of the following, and a long description:
[ EXCEPTION | FINE | INFO | SEVERE | WARNING ]
Update an Event handler on the tenant.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates Success
name
The human-readable name for the handler.
content
Base64 JavaScript code to be run for this handler. Without the encoding the request will trip API security scanners.
description
A description of the handler.
status
Is the handler ACTIVE or DISABLED?
weight
The priority given to this policy; higher values mean higher priority.
configuration
A map of key/value pairs containing runtime configuration values for the handler. These attributes can be retrieved by the handler code via the ctx.getConfig() call.
Adapt will treat a key as sensitive if the name:
\ncontains ‘key’
\ncontains ‘secret’
\ncontains ‘token'
\nbegins with ‘pass’
\nSecrets in configuration can be saved via the UI, but they will not be returned to the UI on the read calls. Instead, a string will be returned. Handler authors should name secret keys with one of these, to avoid leaks on the admin UI.
\nActual secret values will still be available to the handler at runtime.
\n{\n \"eventHandlerId\": \"<string>\",\n \"version\": <long>,\n \"lambdaRequestId\": \"<string>\"\n}\n\neventHandlerId
The unique identifier assigned to the handler.
version
A date-formatted version for the handler.
lambdaRequestId
A trace identifier used to determine the specific invocation run by this API call.
Delete an Event Handler by its id attribute.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n204 No Content
Indicates success.
id
The unique identifier for the handler to be deleted.
The Response Body is empty. Check the Status Codes for indications of success or failure.
\nGet Event information for a single user or device within the specified date window.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates success.
entityIdOrName
The username or deviceId on which to search.
startDate
The start date in Epoch time format.
endDate
The end date in Epoch time format.
The response returns an Audit Trail Event object. All Event attributes are described under Search for Audit Trail Events (GET /cc/api/versioned/audit/search).
An empty data object indicates no results matched the Request.
\nCreate custom Event handlers to augment data and trigger actions.
\nSee the article in our Product Documentation for a full description of HYPR Adapt Event Handlers.
\n","_postman_id":"7d1babdc-8ee2-4a99-8841-8c4b21927246","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Signals","item":[{"name":"Generic","id":"8709646b-b9b7-423d-ab84-f2b7b529e2fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"myattribute\": \"Send generic/custom Events to HYPR Adapt.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.5.0
\n204
Indicates success.
source
JSON path of an attribute in the Request Body, to be used as the originating source of this event. If the attribute does not exist, the value of the URL parameter is used as-is.
eventName
JSON path of an attribute in the Request Body, to be used as the name of this event. If the attribute does not exist, the value of the URL parameter is used as-is.
entityIdOrName
JSON path of an attribute in the Request Body, to be used as the entity name or Id. This the entity (browser, device, etc.) associated with the event.
Valid JSON payload representing the event being sent.
\nmyattribute
The entity attribute to be queried.
myuser
The target user associated with the entity.
nestedData
An array of nested entity attributes.
mynestedattr: User-defined entity attribute.
\nversion: The version of the entity in question.
\nprovider: The name of the entity's provider or vendor.
\nThe call /rp/api/signal/generic/nestedData.provider/MyAuthEvent/myuser is processed as follows:
source - nestedData.provider is resolved to microsoft
eventName - MyAuthEvent is not an attribute of the body, hence used as-is
entityIdOrName - myuser is resolved to Joe Citizen
The event is now tagged and saved as MyAuthEvent from microsoft, foruser Joe Citizen
The Response Body is empty. See Status Codes for success/failure indications.
\nSee the Documentation Tab.
\n","type":"text/plain"},"type":"any","value":"","key":"source"},{"description":{"content":"See the Documentation Tab.
\n","type":"text/plain"},"type":"any","value":"","key":"eventName"},{"description":{"content":"See the Documentation Tab.
\n","type":"text/plain"},"type":"any","value":"","key":"entityIdOrName"}]}},"response":[{"id":"5ae6bda4-113e-447d-8ba4-628ca11b1e9f","name":"204","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"myattribute\": \"registeredMachineId\",\r\n \"myuser\": \"Joe Citizen\",\r\n \"nestedData\": {\r\n \"mynestedattr\": \"10.0.0.0\",\r\n \"version\": \"7.2.0\",\r\n \"provider\": \"microsoft\"\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/rp/api/signal/generic/:source/:eventName/:entityIdOrName","host":["{{baseUrl}}"],"path":["rp","api","signal","generic",":source",":eventName",":entityIdOrName"],"variable":[{"key":"source","value":"","description":"See the Documentation Tab."},{"key":"eventName","value":"","description":"See the Documentation Tab."},{"key":"entityIdOrName","value":"","description":"See the Documentation Tab."}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8709646b-b9b7-423d-ab84-f2b7b529e2fe"}],"id":"d26659a5-b0f9-4175-9db0-94b2244bb760","_postman_id":"d26659a5-b0f9-4175-9db0-94b2244bb760","description":"","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Create or update HYPR Adapt policies.","id":"26f714f1-4dd8-4916-abd6-e03e41cdb165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"HB Trusted\",\r\n \"description\": \"Trusted connections\",\r\n \"status\": \"ACTIVE\",\r\n \"policyContentType\": \"BUILT_IN\",\r\n \"policyType\": \"POST_FIDO_AUTH\",\r\n \"weight\": 125,\r\n \"metadata\": null,\r\n \"createdBy\": \"Joan\",\r\n \"policyConfigurations\": {\r\n \"numberOfFailures\": 3,\r\n \"numericalTimeoutLength\": 20,\r\n \"incrementOfTimeout\": \"minutes\",\r\n \"allowQRWhenUserIsBlocked\": false\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/integrations/adapt/policies","description":"Create and update policies in AWS for a specific tenant, specified by tenantUuid.
\nIf the policyId does not match an existing policy, the call will create a new policy with the stated policyId.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.7.0.
\n200 OK
Indicates success.
name
The name of the policy.
description
The description of the policy.
status
The current status of the policy.
[ ACTIVE | DISABLED ]
policyContentType
Determines if the policy is generated by CC (BUILT_IN; taken from the policyConfigurations property herein) or not (CUSTOM; uses the content attribute instead).
[ BUILT_IN | CUSTOM ]
policyType
Using a policy already associated with the rpAppId, determine to which operation this policy will be applied.
[ PRE_WEB_AUTH | PRE_FIDO_AUTH | PRE_FIDO2_AUTH | PRE_WORKSTATION_UNLOCK | POST_WEB_AUTH | POST_FIDO_AUTH | POST_WORKSTATION_UNLOCK | PRE_AUTH_INTEGRATIONS | POST_AUTH_INTEGRATIONS ]
weight
The relative priority of the policy. Higher values have higher priority.
metadata
Additional information about the policy.
createdBy
The user who created the policy.
policyConfigurations
An array containing configuration settings, mirroring basic Adapt Risk Policy settings in Control Center. All 4 configurations must be submitted if there is not a full policy engine script added manually.
numberOfFailures: The number of failures permitted before a used is blocked.
\nnumericalTimeoutLength: The number of incrementOfTimeout before a user can attempt to login again.
\nincrementOfTimeout: A unit of measurement to qualify numericalTimeoutLength. [ seconds | minutes | hours | days ]
allowQRWhenUserIsBlocked: Determined whether or not blocked users are still permitted to authenticate using a QR code. [ true | false ]
{\n \"message\": \"<string>\",\n \"awsRequestId\": \"<string>\"\n}\n\nmessage
A unique identifier appended with VER version timestamp and saved as a copied reference to the created policy. This policy can be found by both it's original policyId and the VER value on returned in the response.
awsRequestId: A unique identifier assigned to the Amazon Web Services (AWS) request.
\nRetreive a HYPR Adapt policy.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.7.0.
\n200 OK
Indicates success.
policyId (string)
The unique identifier for the policy.
tenantUuid (not visible)
The universally unique identifier (UUID) for the HYPR tenant; generated and added to the call by Control Center.
The Request Body is empty.
\n[\n {\n \"id\": \"<string>\",\n \"tenantUuid\": \"<string>\",\n \"name\": \"<string>\",\n \"content\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"weight\": <integer>,\n \"metadata\": \"<string>\",\n \"createdAt\": <datetime>,\n \"createdBy\": \"<string>\",\n \"version\": <long>,\n \"allVersions\": {\n \"version\": <long>,\n \"createdAt\": <datetime>\n }\n }\n]\n\nThe Response Body attributes are the same as the same-name attributes in the Request Body for Create or update HYPR Adapt policies (POST /cc/api/integrations/adapt/policies).
content
When retrieving a policy that was created using policyConfigurations via CC, the content of the policy contains the template of the authentication policy with the specified configurations included. Comments in the script explain how the configurations are placed.
createdAt
The timestamp for when the policy was created.
version
The VER value returned in the message attribute from Create or update HYPR Adapt policies (POST /cc/api/integrations/adapt/policies).
See the Documentation tab.
\n","type":"text/plain"},"type":"any","value":"","key":"policyId"}]}},"response":[{"id":"62ac17c3-4c91-440f-be18-cab790b42486","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/cc/api/integrations/adapt/policies/:tenantUuid/:policyId","path":["cc","api","integrations","adapt","policies",":tenantUuid",":policyId"],"variable":[{"key":"tenantUuid","value":"","description":"See the Documentation tab."},{"key":"policyId","value":"","description":"See the Documentation tab."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": \"20fbc289-dde2-4509-8b9b-e2abe845fbdd\",\r\n \"tenantUuid\": \"1aced22c-75ba-46c3-8f26-375d67e38316\",\r\n \"name\": \"HB Risky Locs II\",\r\n \"content\": \"package authz...\",\r\n \"description\": \"Risk evaluation policy\",\r\n \"status\": \"ACTIVE\",\r\n \"policyContentType\": \"BUILT_IN\",\r\n \"adaptUnavailableFallbackMethod\": \"QR_ONLY\",\r\n \"weight\": 100,\r\n \"metadata\": \"null\",\r\n \"createdAt\": 1698418331077,\r\n \"createdBy\": \"null\",\r\n \"version\": 2023102724525107,\r\n \"policyConfigurations\": {\r\n \"numberOfFailures\": 5,\r\n \"numericalTimeoutLength\": 10,\r\n \"incrementOfTimeout\": \"minutes\",\r\n \"allowedAuthenticators\": null\r\n }\r\n }\r\n]"}],"_postman_id":"a9d7b785-8051-4ceb-8a98-fc91abf8a419"},{"name":"List all policies by policyId and version.","id":"9bf9fbc3-54b8-4dbd-9be2-1ddff6e1b19e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{baseUrl}}/cc/api/integrations/adapt/policies/:policyId/:version","description":"Retreive a list of all HYPR Adapt policies for one tenant.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.7.0.
\n200 OK
Indicates success.
policyId (string)
The universally unique identifier (UUID) for the HYPR tenant.
version
The policy version in timestamp format.
The Request Body is empty.
\n[\n {\n \"id\": \"<string>\",\n \"tenantUuid\": \"<string>\",\n \"name\": \"<string>\",\n \"content\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"policyContentType\": \"<string>\",\n \"adaptUnavailableFallbackMethod\": \"<string>\",\n \"weight\": <integer>,\n \"metadata\": \"<string>\",\n \"createdAt\": <datetime>,\n \"createdBy\": \"<string>\",\n \"version\": <long>,\n \"policyConfigurations\": {\n \"numberOfFailures\": <integer>,\n \"numericalTimeoutLength\": <integer>,\n \"incrementOfTimeout\": \"<string>\",\n \"allowedAuthenticators\": \"<string>\"\n }\n },\n {\n . . .\n }\n]\n\nThe Response Body attributes are the same as the same-name attributes in the Request Body for Create or update HYPR Adapt policies. (POST /cc/api/integrations/adapt/policies).
content
When retrieving a policy that was created using policyConfigurations via CC, the content of the policy contains the template of the authentication policy with the specified configurations included. Comments in the script explain how the configurations are placed.
adaptUnavailableFallbackMethod
What happens when HYPR Adapt is unavailable?
STANDARD: Use the standard workflow.
BLOCKED: Block Authentication completely.
QR_ONLY: Only allow QR scan authentication.
createdAt
The timestamp for when the policy was created.
version
The VER value returned in the message attribute from Create or update HYPR Adapt policies (POST /cc/api/integrations/adapt/policies).
See the Documentation tab.
\n","type":"text/plain"},"type":"any","value":"","key":"policyId"},{"description":{"content":"See the Documentation tab.
\n","type":"text/plain"},"type":"any","value":"","key":"version"}]}},"response":[{"id":"29fb7443-5287-4e04-be5c-51f697d309d3","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/cc/api/integrations/adapt/policies/:tenantUuid","path":["cc","api","integrations","adapt","policies",":tenantUuid"],"variable":[{"key":"tenantUuid","value":"","description":"See the Documentation tab."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": \"20fbc289-dde2-4509-8b9b-e2abe845fbdd\",\r\n \"tenantUuid\": \"1aced22c-75ba-46c3-8f26-375d67e38316\",\r\n \"name\": \"HB Risky Locs II\",\r\n \"content\": \"package authz...\",\r\n \"description\": \"Risk evaluation policy\",\r\n \"status\": \"ACTIVE\",\r\n \"policyContentType\": \"BUILT_IN\",\r\n \"adaptUnavailableFallbackMethod\": \"QR_ONLY\",\r\n \"weight\": 100,\r\n \"metadata\": \"null\",\r\n \"createdAt\": 1698418331077,\r\n \"createdBy\": \"null\",\r\n \"version\": 2023102724525107,\r\n \"policyConfigurations\": {\r\n \"numberOfFailures\": 5,\r\n \"numericalTimeoutLength\": 10,\r\n \"incrementOfTimeout\": \"minutes\",\r\n \"allowedAuthenticators\": null\r\n }\r\n }\r\n]"}],"_postman_id":"9bf9fbc3-54b8-4dbd-9be2-1ddff6e1b19e"},{"name":"Get all HYPR Adapt policies for a tenant.","id":"02b5dd4a-ea21-4a51-b8bd-68e102752ed5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"*/*"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/integrations/adapt/policies","description":"Retreive a list of all HYPR Adapt policies for one tenant.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates success.
The Request Body content is empty.
\n[\n {\n \"id\": \"<string>\",\n \"tenantUuid\": \"<string>\",\n \"name\": \"<string>\",\n \"content\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"<string>\",\n \"policyContentType\": \"<string>\",\n \"weight\": <integer>,\n \"metadata\": \"<string>\",\n \"createdAt\": <datetime>,\n \"policyConfigurations\": {\n \"numberOfFailures\": <integer>,\n \"eventWindowLength\": {\n \"numericLength\": <integer>,\n \"timeIncrement\": \"<string>\"\n },\n \"userTimeoutLength\": {\n \"numericLength\": <integer>,\n \"timeIncrement\": \"<string>\"\n },\n \"allowedAuthenticators\": [\n \"string>\"\n ]\n },\n \"allVersions\": [\n {\n \"version\": <long>,\n \"createdAt\": <datetime>\n },\n {\n ...\n }\n ]\n },\n {\n ...\n }\n]\n\nid
The unique identifier for the policy.
tenantUuid
The unique identifier for the tenant.
name
The policy name.
content
The content of the policy, which may include composite elements such as code or more JSON.
description
The policy description.
status
Is the policy active or disabled?
[ ACTIVE | DISABLED ]
policyContentType
Is this a prefabricated policy or a custom policy?
[ BUILT_IN | CUSTOM ]
weight
The priority given to this policy; higher values mean higher priority.
metadata
An array containing additional data points, some of which may mirror the policyConfigurations values.
createdAt
The timestamp when this policy was created.
policyConfigurations
An array representing the Risk Policy configuration setting as seen in Control Center.
numberOfFailures: The limit to how many failures a user can experience before being blocked.
\neventWindowLength: An array containing time information for the event window.
\nnumericLength: The number of units for the timeIncrement.
\ntimeIncrement: The units of time used. [ seconds | minutes | hours | days ]
userTimeoutLength: An array containing time information for the user timeout.
\nnumericLength: The number of units for the timeIncrement.
\ntimeIncrement: The units of time used. [ seconds | minutes | hours | days ]
allowedAuthenticators: A list of allowed AAGUIDs.
\nallVersions: A list of versions and create dates.
\nversion: A timestamp representing the version.
\ncreatedAt: The same timestamp in Epoch format.
\nUpdate a custom HYPR Adapt Risk Policy.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates success.
id
The unique identifier for the handler.
name
The handler name.
description
A description of the handler
status
Is the handler active?
[ ACTIVE| DISABLED ]
policyContentType
Are you using out-of-the-box handlers or your own?
[ BUILT_IN | CUSTOM ]
weight
A value from 1 to 10000 indicating the order of handlers for execution.
metadata
Additional information about the policy.
createdBy
The username of the handler's creator.
policyConfigurations
An array containing configuration settings, mirroring basic Adapt Risk Policy settings in Control Center. All 4 configurations must be submitted if there is not a full policy engine script added manually.
seconds | minutes | hours | days ]true | false ]{\n \"message\": \"<string>\",\n \"policyId\": \"<string>\",\n \"lambdaRequestId\": \"<string>\"\n}\n\nmessage
Currently this echoes the policyId.
policyId
The unique policy identifier, which will match the one from the Request Body.
lambdaRequestId
A trace identifier used to determine the specific invocation run by this API call.
Remove an Adapt policy from the server.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 8.7.0.
\n200 OK
Indicates success.
policyId <string>\nThe unique identifier for the policy; obtained using one of the HYPR Adapt GET calls.
The Request Body is empty.
\nThe Response Body is empty. Check the Status Codes for success or failure.
\nSee the Documentation tab.
\n","type":"text/plain"},"type":"any","value":"","key":"policyId"}]}},"response":[{"id":"59247dc6-f47b-4f57-b49f-bd3cd28ec1bd","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/cc/api/integrations/adapt/policies/:tenantUuid/:policyId","path":["cc","api","integrations","adapt","policies",":tenantUuid",":policyId"],"variable":[{"key":"tenantUuid","value":""},{"key":"policyId","value":"","description":"See the Documentation tab."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cebe1ec1-56d3-475c-a418-642285eae1e9"},{"name":"Evaluate an Adapt Risk Policy.","id":"96716bf3-2a1e-413b-9f40-c4500600cb2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"Performs policy evaluation for a given user's authentication. The policyId and requested lifecycle will be used from the associated rpAppId, determined by the Bearer Token.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
userName
The user name or entityId for whom we are making the policy evaluation request.
supportingEntities
Additional entityId(s) to lookup stored data on. All events for these entities will be passed to the policy.
For example, an IP address and/or deviceId may be passed in. Adapt looks up any event data it has on these and provides to the policy evaluation.
\nevaluationPoint
The evaluation point at which this policy will be executed by Control Center (CC). This will be one of the following values:
PRE_WEB_AUTH
Web pre-authentication
\nFor OOB/QR flows, this is invoked before the push message is sent, to block push bombing
\nFor FIDO2, this is invoked on assertions/options, since there is no other pre-step for FIDO2
\nPOST_WEB_AUTH
Web post-authentication
\nOn /rp/api/oob/client/authentication/requests/{requestId} and request status == COMPLETED
PRE_FIDO_AUTH
HYPR Mobile App pre-authentication
\nOn fido/get/auth
POST_FIDO_AUTH
HYPR Mobile App post-authentication
\nOn fido/send/auth
PRE_FIDO2_AUTH
FIDO2 Passkey pre-authentication
\nOn fido2/assertion/options
POST_FIDO2_AUTH
FIDO2 Passkey post-authentication
\nOn fido2/assertion/result
PRE_AUTH_INTEGRATIONS and POST_AUTH_INTEGRATIONS
Track the policy check before/after an authentication request from a HYPR integration
\nFor example:
\nNote: In Keycloak, the POST evaluation point call is not implemented yet
\nPRE_WORKSTATION_UNLOCK
At the start of the workstation unlock request
\n/client/authorize/unlockPOST_WORKSTATION_UNLOCK
At the start of the workstation unlock request
\nOn client/authorization/complete/{sessionId}
On client/verification/complete/{sessionId}
policyId
If you created a custom policy not linked to an app, you can provide the policyId directly. In this case the evaluationPoint attribute is not needed.
The evaluationPoint approach is recommended. It avoids hard coding the policyId into API clients.
\ndata
Optional, discretionary data sent along with the policy. This will be passed to the risk engine and can be used for decision making.
CC will look up its config to see which policy is associated to the RPApp for the policyLifeCycle (PRE_FIDO_AUTH).
If no policy is found, nothing happens
\nIf a policy is found, Adapt is invoked and the result is proxied back.
\n{\n \"type\": \"/static/docs/com/hypr/server/integrations/adapt/errors/PolicyNotFoundException.html\",\n \"title\": \"Adapt Policy Not Found\",\n \"status\": 404,\n \"detail\": \"Please contact HYPR customer support and report this issue. ExceptionId: b366c444-3641-4468-9efe-d879157b1701\",\n \"errorCode\": 1201089\n}\n\ntype
The path to the HTML file handling the status code.
title
The title of the status message.
status
The HTML status code.
detail
The message accompanying the status.
errorCode
The HYRP Error code, as described in the HYPR Error Codes and Troubleshooting Table.
This can occur of Adapt is not enabled or has been misconfigured.
\n{\n \"type\": \"/static/docs/com/hypr/server/integrations/adapt/errors/InvalidAdaptConfigurationException.html\",\n \"title\": \"Invalid Adapt Configuration\",\n \"status\": 500,\n \"detail\": \"Please contact HYPR customer support and report this issue. ExceptionId: 49bdff1f-e751-479c-aa39-01bbf3be5950\",\n \"errorCode\": 1201087\n}\n\n:
\n","urlObject":{"path":["cc","api","integrations","adapt","policies","policy_evaluation"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"09e5e7d5-1440-43ac-8557-10621d837fa6","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/integrations/adapt/policies/policy_evaluation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":""},{"id":"ebf5157e-ddd6-495e-b05a-fdf515cca0a8","name":"404 Adapt Policy Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"Tests a policy evaluation against supplied data.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 9.0.0.
\n200 OK
testPolicyContent
A data object containing the JSON mimicking the Event data. The example shown here is the default policy with which HYPR ships. Note the encapsulated JSON must use \\r\\n to be parsed correctly as an Event.
testData
An array containing the data to be tested.
CC or HYPR.AUDIT.BROWSER | CONTROL_CENTER_SERVER | MOBILE_DEVICE | RELYING_PARTY_SERVER | UAF_SERVER | WEB | WORKSTATION ]true | false ]{\n \"message\": \"<string>\",\n \"allowed\": <boolean>,\n \"allowedAuthenticators\": [\n \"<string>\",\n \"<string>\"\n ],\n \"result\": {\n \"allowed\": <boolean>,\n \"allowedAuthenticators\": [\n \"<string>\",\n \"<string>\"\n ],\n \"currentSystemTime\": <datetime>,\n \"message\": \"<string>\",\n \"withinTheAuthenticationFailureLimit\": <boolean>\n },\n \"policyId\": \"<string>\",\n \"policyName\": \"<string>\",\n \"policyVersion\": \"<string>\",\n \"evalDataStartDate\": <datetime>,\n \"evalDataEndDate\": <datetime>,\n \"evalEventCount\": <datetime>\n}\n\nmessage
The error message content. This echoes the same-name attribute in result.
allowed
Boolean value indicating if the current condition allowed the user to continue. This echoes the same-name attribute in result.
[ true | false ]
allowedAuthenticators
A comma-separated list of authenticator options. This echoes the same-name attribute in result.
[ FIDO2, QR ]
result
An array containing policy evaluation results.
allowed: Boolean value indicating if the current condition allowed the user to continue. This echoes the same-name attribute in result. [ true | false ]
allowedAuthenticators: A comma-separated list of authenticator options. [ FIDO2 | QR ]
currentSystemTime: The system time of the evaluation request in Epoch format.
\nmessage: The error message content.
\nwithinTheAuthenticationFailureLimit: Boolean value indicating whether or not the user has exceeded the allowed number of failed authentication attempts. [ true | false }
policyId
The unique identidier for the policy.
policyName
The human-readable name assigned to the policy at creation.
policyVersion
A date-formatted version for the policy.
evalDataStartDate
The timestamp when the evaluation test began.
evalDataEndDate
The timestamp when the evaluation test ended.
evalEventCount
The number of affected Events.
Temporarily add a user to the HYPR Adapt allowlist.
\nSuccess will generate the ADAPT_POLICY_EVAL_USER_ALLOWLISTED Event.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 8.7.0.
\n200 OK
Even if unsuccessful.
username
The HYPR username to be allowlisted.
rpAppId
The camel case unique RP aPpplication identifier.
{\n \"isSuccessful\": boolean,\n \"error\": \"<string>\"\n}\n\nisSuccessful
Boolean value indicating sucess or failure. [ true | false ]
error
If isSuccessful is true, thiswill be null. If isSuccessful is false, the error will contain the error message body.
Retreive a single HYPR Adapt policy's configuration.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 9.3.0.
\n200 OK
Indicates success.
The Request Body content is empty.
\n{\n \"<Evaluation Point>\": {\n \"evaluationPoint\": \"<string>\",\n \"policyId\": \"<string>\",\n \"evalResponseUnavailableFallback\": \"<string>\",\n \"loggingOnlyEnforcementEnabled\": <Boolean>\n},\n \"<Evaluation Point>\": {\n ...\n },\n ...\n \"isAnyEvalPointAssigned\": <boolean>\n}\n\nEvaluation Point
\nThe camel case name for the evaluation point, representing an array of configuration values for a policy's evaluation points. This will be one of the following:
\n[ preFidoAuth | postFidoAuth | postWebAuth | preFido2Auth | postFido2Auth | preWorkstationUnlock | postWorkstationUnlock | preAuthIntegrations | postAuthIntegrations | preWebAuth ]
evaluationPoint: The all-caps corresponding evaluation point name.
[ PRE_FIDO_AUTH | POST_FIDO_AUTH | POST_WEB_AUTH | PRE_FIDO2_AUTH | POST_FIDO2_AUTH | PRE_WORKSTATION_UNLOCK | POST_WORKSTATION_UNLOCK | PRE_AUTH_INTEGRATIONS | POST_AUTH_INTEGRATIONS | PRE_WEB_AUTH ]
policyId: The unique identifier for the affected policy. If no policies use this evaluation point, the value will be null.
\nevalResponseUnavailableFallback: HYPR Adapt's fallback when there is no response. If no fallback is defined, this value will be null. Valid values include the following:
\nSTANDARD: Use the default authentication flow.
BLOCKED: Issue a Blocked warning to the user until the time allotted in
isAnyEvalPointAssigned
If no evaluation points are in use, this will be false. Otherwise it will be true.
[ true | false ]
Retrieve all HYPR Adapt policy configurations ordered by rpAppId.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.3.0.
\n200 OK
Indicates success.
The Request Body content is empty.
\nResponse Body attributes are identical to those of List a policy configuration GET /cc/api/appconfig/adapt.
[\n {\n \"rpAppId\": \"<string>\",\n \"rpAppAdaptConfig\": {\n \"<Evaluation Point>\": {\n \"evaluationPoint\": \"<string>\",\n \"policyId\": \"<string>\",\n \"evalResponseUnavailableFallback\": \"<string>\",\n \"loggingOnlyEnforcementEnabled\": <Boolean>\n },\n \"\": {\n ...\n },\n ...\n \"isAnyEvalPointAssigned\": <boolean>\n }\n },\n {\n \"rpAppId\": \"<string>\",\n \"rpAppAdaptConfig\": {\n ...\n }\n },\n {\n ...\n }\n]\n\nrpAppId
The camel case unique idenfier for the RP application.
Assign an Adapt policy for an rpAppId to a single evaluation point.
\nTo unassign a policy from a single evaluation point, leave the policyId blank in the Request Body.
\nThe Bearer Token must be the controlCenterAdmin token.
\nAdded in HYPR version 9.3.0.
\n200 OK
Indicates a valid policyId and a valid rpAppId.
400 Bad Request
May indicate any non-valid condition:
- The policyId is valid but the rpAppId is not
\n- The policyId is not valid but the rpAppId is
\n- The policyId and rpAppId are both not valid
\nevaluationPoint
The all-caps corresponding evaluation point name.
[ PRE_FIDO_AUTH | POST_FIDO_AUTH | POST_WEB_AUTH | PRE_FIDO2_AUTH | POST_FIDO2_AUTH | PRE_WORKSTATION_UNLOCK | POST_WORKSTATION_UNLOCK | PRE_AUTH_INTEGRATIONS | POST_AUTH_INTEGRATIONS | PRE_WEB_AUTH ]
policyId
The unique identifier for the desired policy. This value can be obtained using List all policies by policyId and version. IF left blank for a given evaluationPoint, the policy will be removed from the evaluation point while retaining the rest.
evalResponseUnavailableFallback
HYPR Adapt's fallback when there is no response. If no fallback is defined, this value will be null. Valid values include the following:
STANDARD: Use the default authentication flow
BLOCKED: Issue a Blocked warning to the user until the time allotted in Create or update HYPR Adapt policies
loggingOnlyEnforcementEnabled
Enable this feature to only generate logs and not actually enforce this policy. Used for testing and verification.
[ true | false ]
rpAppId
The camel case unique RP application identifier.
{\n \"id\": <long>,\n \"rpAppId\": \"<string>\",\n \"configType\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"createDateInUTC\": <long>,\n \"updatedAt\": <long>\n}\n\nid
The unique identifier for the policy assignment.
rpAppId
The camel case unique RP application identifier.
configType
The type of configuration to which the assignment applies.
[ ADAPT | DEVICE ]
name
The name of the assignment.
value
An array listing the evaluation points using values reflective of the structure of Get policy assignments for all apps.
metatdata
Any additional information to be included.
createDateInUTC
UTCepoch timestamp at the time the assigment was created.
updatedAt
UTC epoch timestamp at the time of the last update.
Create or update a full assignment configuration for an RP application. This can be used to change multiple policy and fallback assignments at once.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 9.3.0.
\n200 OK
Indicates success.
The Request Body content is identical to the Response Body from Get policy assignments for all apps.
\nThe simplest way to populate the Request Body is to run Get policy assignments for all apps, then paste the Response Body into the Request Body here; make any needed adjustments, then run it.
\nThe Response Body mirrors the Request Body.
\nRemove all assignments for the specified rpAppId, which is derived from the Bearer Token.
\nNOTE: To unassign a policy from a single evaluation point, run Assign a policy to an evaluation point for an rpAppId and leave the policyId blank in the Request Body.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 9.3.0.
\n204 No Content
Indicates success.
rpAppId (string)
The camel case unique RP application identifier.
The Request Body is empty.
\n{\n \"msg\": \"Deleted Adapt config. appId=controlCenterAdmin\"\n}\n\nmsg
A message indicating the status of the response.
See the Documentation Tab.
\n","type":"text/plain"},"type":"any","value":"","key":"rpAppId"}]}},"response":[],"_postman_id":"7deb7360-c7bc-4ce7-945f-7037a2ed7e55"}],"id":"d247760a-ccee-4970-9bad-0d3f97b7d9ec","description":"Control HYPR Adapt policies governing user risk evaluation.
\nRisk is assessed at all endpoints for logging in, including FIDO2 assertion endpoints.
\nUse this as a template to create custom policies.
\n{\n \"name\": \"testPolicy1\",\n \"description\": \"Risk evaluation policy\",\n \"status\": \"ACTIVE\",\n \"policyContentType\": \"BUILT_IN\",\n \"policyType\": \"PRE_FIDO_AUTH\",\n \"weight\": 100,\n \"metadata\": \"null\",\n \"createdBy\": \"Sean\",\n \"policyConfigurations\": {\n \"numberOfFailures\": 2,\n \"numericalTimeoutLength\": 30,\n \"incrementOfTimeout\": \"minutes\",\n \"allowQRWhenUserIsBlocked\": true\n }\n}\n\nSee the articles in our Product Documentation for a full description of HYPR Adapt functionality.
\n","_postman_id":"d247760a-ccee-4970-9bad-0d3f97b7d9ec","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Extensions","item":[{"name":"List all extensions running on the server.","id":"d33e8cc6-3261-4bb2-9159-623c223b3aa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/extension/list/all","description":"A valid extensions .jar will be installed and started on upload.
Extension APIs only function on hosted and on-premises deployments.
\nThis call requires a controlCenterAdmin access token.
\nAdded in HYPR version 3.7.0.
\n200 OK
The Request Body is empty.
\nThe Response Body parameters are identical to Install an extenstions _.jar_ file (POST /cc/api/extension), and may include multiple parameter sets if more than one extension is present.
(Required)
\n","type":"text"}]},"url":"{{baseUrl}}/cc/api/extension","description":"A valid extensions .jar will be installed and started on upload.
\nExtension APIs only function on hosted and on-premises deployments.
\nThis call requires a controlCenterAdmin access token.
\nAdded in HYPR version 3.7.0.
\n200 OK
binary
The multi-part form data to be uploaded.
The Request Body is empty. The binary value must be added to the path.
\n{\n \"associatedWithRPAppIds\": [\n \"<string>\"\n ],\n \"extensionsLoaded\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"klass\": \"<string>\",\n \"state\": \"<string>\",\n \"stateMsg\": \"<string>\",\n \"version\": \"<string>\",\n \"provider\": \"<string>\",\n \"extensionPath\": \"<string>\"\n}\n\nassociatedWithRPAppIds
A comma-separated list of rpAppId values with which this extension is associated. This functionality is the same as selecting added extensions in the UI under Control Center > Advanced Config > Extensions.
extensionsLoaded
A comma-separated list of extensions from the klass.
Example format: com.your-server.plugins.okta.OktaPlugin$OktaFoo
id
The name assigned to the extension. This might appear in the stateMsg.
EX: cc-okta-plugin
klass
The base class from which associated extensions depend.
EX: com.your-server.plugins.okta.OktaPlugin
state
The current state of the extension.
[ STARTED | STOPPED | RESOLVED ]
stateMsg
A message accompanying the state. Typical responses may be:
OKExtensionId (or productId): is UP across all nodesversion
The version of the extension.
provider
The original creator of the extension.
extensionPath
The relative path to the extension files.
Using the Id value found in List all extsnions running on the server (GET cc/api/extensions), delete an extension from the server.
This call requires a controlCenterAdmin Bearer Token.
\nAdded in HYPR version 3.7.0.
\n204 No ContentIndicates success.
extensionId (string)
The unique identifier for the extension.
The Request Body is empty.
\nThe Response Body is empty. See the Status Codes for results.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","extensions",":extensionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"extensionId"}]}},"response":[{"id":"f6898acd-e75a-44d6-a715-adec83ddc54d","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/cc/api/extensions/:extensionId","host":["{{baseUrl}}"],"path":["cc","api","extensions",":extensionId"],"variable":[{"key":"extensionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"message\"\n }\n]"}],"_postman_id":"31e23e6a-4770-442f-8746-b64454e5091f"}],"id":"b0a957d0-5cef-4237-adb1-1845f6f81ffe","description":"Manage HYPR extensions. When installed, these appear in the Extensions menu in Control Center. If enabled, they will then be eligible for use by individual RP Applications.
\nExtension APIs only function on hosted and on-premises deployments.
\nSee the Control Center Intelligent Extensions article in our Product Documentation for a full description on how to upload, edit, and delete Extensions from Control Center. To learn how to associate them with RP Applications see the Application Config article, Extensions.
\nIf you are interested in creating your own Extensions, see the HYPR SDK Extensions articles.
\n","_postman_id":"b0a957d0-5cef-4237-adb1-1845f6f81ffe","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Support Access","item":[{"name":"List allowed HYPR Support emails.","id":"a450705d-548c-413e-a477-2c9799eafdaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/support/allowed","description":"Retrieve a list of HYPR Support email addresses currently allowed access to Control Center.
\nThe Bearer Token must be the controlCenterAdmin token.
\nSee the HYPR Support Access article in our Product Documentation for a full description of this functionality.
\nAdded in HYPR version 9.0.0.
\n200 OK
Indicates success.
The Request Body is empty.
\n[\n {\"email\": \"<string>\"},\n {\"email\": \"<string>\"}\n]\n\nSee the HYPR Support Access article in our Product Documentation for a full description of this functionality.
\n","_postman_id":"a49265e9-20b6-478c-b3b7-14194d74b4bf","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Affirm","item":[{"name":"Verification Flows","item":[{"name":"Create Verification Flow","id":"d7ac577f-0928-4ef6-a2df-ec221e09ea06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{CCAdminAccessToken}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Flow with NONE approver type\",\r\n \"description\": \"Approver type NONE\",\r\n \"status\": \"ENABLED\",\r\n \"type\": \"CUSTOM\",\r\n \"frictionLevel\": \"NONE\",\r\n \"steps\": [\r\n {\r\n \"name\": \"LOGIN_ID\"\r\n },\r\n {\r\n \"name\": \"PHONE_OR_EMAIL\",\r\n \"settings\": {\r\n \"PHONE_OR_EMAIL_STEP_OTP_ENABLED\": \"true\"\r\n }\r\n },\r\n {\r\n \"name\": \"OUTCOME\",\r\n \"settings\": {\r\n \"OUTCOME_STEP_RESULT\": \"DO_NOTHING\"\r\n }\r\n }\r\n ],\r\n \"approvers\": [\r\n {\r\n \"approverType\": \"NONE\"\r\n }\r\n ],\r\n \"escalationApprovers\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/idv/verification","description":"POST {{baseUrl}}/cc/api/idv/verification
Creates a new identity verification flow configuration.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeVerificationFlow
Content-Type: application/json
Constraints:
\ndisplayName: required, max 30 characters
description: optional, max 255 characters when provided
frictionLevel: must be NONE for this endpoint (use /verification/friction for other levels)
{\n \"id\": \"string (optional, omit for new flow)\",\n \"displayName\": \"string (required, max 30)\",\n \"description\": \"string (optional, max 255)\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"NONE\",\n \"steps\": [\n {\n \"name\": \"VerificationStepName\",\n \"settings\": {\n \"VerificationStepSetting\": \"string value\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n}\n\nsteps)approvers and escalationApprovers)Deprecated: IDV — use DOCUMENT_BIOMETRIC.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description.
POST {{baseUrl}}/cc/api/idv/verification/friction
Creates a new identity verification flow with a predefined friction level (HIGHEST, HIGH, MEDIUM, LOW, or LOWEST). The server generates workflow steps and approvers from the friction level and workflow type. You do not send steps, approvers, or escalationApprovers in the request. For flows with no friction, use POST {{baseUrl}}/cc/api/idv/verification instead.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeVerificationFlow
Content-Type: application/json
Constraints:
\ndisplayName: required, max 30 characters
description: optional, max 255 characters when provided
frictionLevel: must not be NONE. Allowed: HIGHEST, HIGH, MEDIUM, LOW, LOWEST. Use POST {{baseUrl}}/cc/api/idv/verification for no friction.
{\n \"displayName\": \"string (required, max 30)\",\n \"description\": \"string (optional, max 255)\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"HIGHEST | HIGH | MEDIUM | LOW | LOWEST\",\n \"rpAppIdReference\": \"string (optional)\"\n}\n\nDo not send NONE to this endpoint. For flows with no friction, use POST {{baseUrl}}/cc/api/idv/verification.
The response body is the created verification flow object. It includes an id assigned by the server and the full workflow: steps, approvers, and escalationApprovers generated from the requested frictionLevel and type.
Content-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"HIGHEST | HIGH | MEDIUM | LOW | LOWEST\",\n \"steps\": [\n {\n \"name\": \"VerificationStepName\",\n \"settings\": {\n \"VerificationStepSetting\": \"string value\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n}\n\nsteps)approvers and escalationApprovers)Steps in the response use these name values. The server chooses which steps to include based on friction level and type.
Deprecated: IDV — responses use DOCUMENT_BIOMETRIC instead.
Step settings in the response use string values only.
The following settings may appear in response steps depending on step name. All values are strings.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description. Example: \"[{\\\"rule\\\":\\\"192.168.1.0/24\\\",\\\"description\\\":\\\"Corporate network\\\"}]\".
DELETE {{baseUrl}}/cc/api/idv/verification/{id}
Deletes a verification flow by ID. The response body is the deleted verification flow object. After a successful delete, the flow is permanently removed.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeVerificationFlow
The response body is the deleted verification flow object (same structure as returned by GET by id).
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"NONE | HIGHEST | HIGH | MEDIUM | LOW | LOWEST\",\n \"steps\": [\n {\n \"name\": \"VerificationStepName\",\n \"settings\": {\n \"VerificationStepSetting\": \"string value\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n}\n\nsteps)approvers and escalationApprovers)Deprecated: IDV — use DOCUMENT_BIOMETRIC.
Step settings values are always strings in the response.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description.
This endpoint is deprecated. Use {{baseUrl}}/cc/api/idv/verification/list instead for listing verification flows with pagination and sort options.
GET {{baseUrl}}/cc/api/idv/verification
Returns all verification flows in a single response as a JSON array. No query parameters; no pagination. Prefer GET {{baseUrl}}/cc/api/idv/verification/list for paginated results.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readVerificationFlow
scope: hypr:affirm:writeVerificationFlow
The response body is a JSON array of verification flow objects. There is no wrapper object and no pagination metadata.
\nContent-Type: application/json
[\n {\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"NONE | HIGHEST | HIGH | MEDIUM | LOW | LOWEST\",\n \"steps\": [\n {\n \"name\": \"VerificationStepName\",\n \"settings\": {\n \"VerificationStepSetting\": \"string value\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n }\n]\n\nThe response is an array. Each element is a verification flow object with the following fields.
\nsteps)approvers and escalationApprovers)Deprecated: IDV — use DOCUMENT_BIOMETRIC.
Step settings values are always strings in the response.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description. Example: \"[{\\\"rule\\\":\\\"192.168.1.0/24\\\",\\\"description\\\":\\\"Corporate network\\\"}]\".
GET {{baseUrl}}/cc/api/idv/verification/{id}
Returns a single verification flow by ID.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readVerificationFlow
scope: hypr:affirm:writeVerificationFlow
The response body is a single verification flow object.
\nContent-Type: application/json
Note: Response structure is identical to the create endpoint responses. See the example responses under postman-docs/verification-flows/create/.
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"NONE | HIGHEST | HIGH | MEDIUM | LOW | LOWEST\",\n \"steps\": [\n {\n \"name\": \"VerificationStepName\",\n \"settings\": {\n \"VerificationStepSetting\": \"string value\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n}\n\nsteps)approvers and escalationApprovers)Deprecated: IDV — use DOCUMENT_BIOMETRIC.
Step settings values are always strings in the response.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description.
GET {{baseUrl}}/cc/api/idv/verification/list
Returns a paginated list of all verification flows. Use query parameters to control page size, page number, and sort order.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readVerificationFlow
scope: hypr:affirm:writeVerificationFlow
The response body is an object with data (array of verification flow objects) and metadata (pagination info).
Content-Type: application/json
{\n \"data\": [\n {\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"NONE | HIGHEST | HIGH | MEDIUM | LOW | LOWEST\",\n \"steps\": [],\n \"approvers\": [],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n }\n ],\n \"metadata\": {\n \"totalRecords\": 0,\n \"totalPages\": 0,\n \"pageSize\": 20,\n \"currentPage\": 1\n }\n}\n\ndata)Each element in data is a full verification flow object with the following top-level fields.
steps)approvers and escalationApprovers)Deprecated: IDV — use DOCUMENT_BIOMETRIC.
Step settings values are always strings in the response.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description.
PATCH {{baseUrl}}/cc/api/idv/verification
Updates an existing identity verification flow. Send the full verification flow object in the request body; the id field must be set to the ID of the flow to update.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeVerificationFlow
Content-Type: application/json
Constraints:
\nid: required — must be the ID of an existing verification flow.
displayName: required, max 30 characters
description: optional, max 255 characters when provided
frictionLevel: must be NONE for this endpoint (use /verification/friction for other levels)
{\n \"id\": \"string (required, existing flow ID)\",\n \"displayName\": \"string (required, max 30)\",\n \"description\": \"string (optional, max 255)\",\n \"status\": \"ENABLED | DISABLED\",\n \"type\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"frictionLevel\": \"NONE\",\n \"steps\": [\n {\n \"name\": \"VerificationStepName\",\n \"settings\": {\n \"VerificationStepSetting\": \"string value\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"rpAppIdReference\": \"string\",\n \"codeCustomizations\": {},\n \"oidcClientConfigId\": \"string\",\n \"escalateToLiveChat\": false,\n \"contentCustomizationId\": \"string\",\n \"blockDurationMins\": 0,\n \"workflowAttemptLimit\": 10,\n \"workflowAttemptWindowMins\": 0\n}\n\nsteps)approvers and escalationApprovers)Deprecated: IDV — use DOCUMENT_BIOMETRIC.
IP allow / block list format: value is a string containing a JSON array of objects with rule and description. Example: \"[{\\\"rule\\\":\\\"192.168.1.0/24\\\",\\\"description\\\":\\\"Corporate network\\\"}]\".
The response body is the updated verification flow object (same structure as the request body).
\nContent-Type: application/json
The response is a single verification flow object with the same fields as the request. See Request Body Schema and Field descriptions above.
\nThe Verification Flows API provides endpoints for creating, managing, and configuring identity verification workflows. Verification flows define the sequence of verification steps that users must complete during identity verification processes, such as employee onboarding, account recovery, or access requests.
\nVerification flows are configurable workflows that define how identity verification is performed in Affirm. Each flow specifies:
\nSteps: The verification steps users must complete (e.g., phone verification, document check, location verification)
\nStep Settings: Configuration for each step (retry limits, failure outcomes, escalation options)
\nApprovers: Designated approvers who must verify and approve requests
\nOutcomes: What happens after successful or failed verification
\nCustomizations: Content customization kits, code customizations, and styling
\nEmployee Onboarding: Verify new employee identity during onboarding
\nAccount Recovery: Verify user identity when recovering access
\nAccess Requests: Verify identity for sensitive access requests
\nCompliance Verification: Meet regulatory requirements for identity verification
\nCustom Workflows: Create organization-specific verification processes
\nPOST {{baseUrl}}/cc/api/idv/verification
Creates a new verification flow configuration. Send the full flow definition including steps, settings, and approvers. This endpoint only supports frictionLevel: NONE. For flows with friction levels (HIGHEST, HIGH, MEDIUM, LOW, LOWEST), use the friction endpoint below.
POST {{baseUrl}}/cc/api/idv/verification/friction
Creates a new verification flow with a predefined friction level. The server generates steps and approvers from the friction level and workflow type. You send only displayName, description, status, type, frictionLevel, and optionally rpAppIdReference.
Supported Friction Levels:
\nHIGHEST: Maximum security, most verification steps
HIGH: High security, multiple verification steps
MEDIUM: Balanced security and user experience
LOW: Lower security, fewer verification steps
LOWEST: Minimal security, basic verification steps
GET {{baseUrl}}/cc/api/idv/verification/{id}
Retrieves a single verification flow by ID. Returns the complete flow configuration including all steps, settings, and approvers.
\nGET {{baseUrl}}/cc/api/idv/verification/list
Retrieves a paginated list of verification flows. Query parameters: pageNumber (default 1), pageSize (default 20, max 50), orderBy (name, type, description, status, created_at), sortDir (asc, desc). Response includes data (array of flows) and metadata (totalRecords, totalPages, pageSize, currentPage).
GET {{baseUrl}}/cc/api/idv/verification
Deprecated. Returns all verification flows in a single array with no pagination. Use GET {{baseUrl}}/cc/api/idv/verification/list instead.
PATCH {{baseUrl}}/cc/api/idv/verification
Updates an existing verification flow. Send the full verification flow object in the request body with id set to the flow to update.
DELETE {{baseUrl}}/cc/api/idv/verification/{id}
Deletes a verification flow by ID. The response body is the deleted flow. This action cannot be undone.
\nAll endpoints require a Bearer token and one of the following scopes:
\nDeprecated: IDV — use DOCUMENT_BIOMETRIC.
Each step can be configured with settings. All setting values are strings in requests and responses (booleans as \"true\"/\"false\", numbers as strings, IP lists as JSON-encoded string arrays). Unknown setting keys are silently ignored.
Most steps support a common set of failure-handling settings (replace {STEP} with the step prefix, e.g. PHONE_OR_EMAIL_STEP, LOCATION_STEP, DOCUMENT_BIOMETRIC_STEP, DOCUMENT_LIVENESS_STEP, VERIFIED_CREDENTIAL_STEP):
Plus common failure settings with prefix PHONE_OR_EMAIL_STEP.
Plus common failure settings with prefix LOCATION_STEP.
Plus common failure settings with prefix DOCUMENT_BIOMETRIC_STEP.
Deprecated: IDV_STEP_\\* settings are accepted but deprecated. Use DOCUMENT_BIOMETRIC_STEP_\\* equivalents instead.
Plus common failure settings with prefix DOCUMENT_LIVENESS_STEP.
Plus common failure settings with prefix VERIFIED_CREDENTIAL_STEP.
Approvers: Primary approvers who review requests
\nEscalation approvers: Contacted if regular approvers do not respond
\nApprover fields: email, phoneNumber, approverType (MANAGER, SOMEONE_ELSE, DYNAMIC, NONE), oidcClientConfigId, inviteNextApproverAfterMinutes
Success outcome (OUTCOME_STEP_RESULT):
HYPR_DEVICE_MANAGER — Redirect to Device Manager
ISSUE_ENTRA_TAP — Issue Microsoft Entra TAP
ISSUE_ENTRA_VERIFIABLE_CREDENTIAL — Issue Microsoft Entra Verified Credential
REDIRECT — Redirect to custom URL
OKTA_PASSWORD_RESET — Initiate Okta password reset
DO_NOTHING — Complete without additional action
Failure outcome (FAILURE_OUTCOME_STEP_RESULT):
REDIRECT — Redirect to custom URL
DO_NOTHING — Complete without additional action
Friction level is set at creation time. Use POST {{baseUrl}}/cc/api/idv/verification for NONE; use POST {{baseUrl}}/cc/api/idv/verification/friction for all other levels.
Errors use RFC 7807 Problem Details (e.g. application/json). Example:
{\n \"title\": \"Verification Flow Problem\",\n \"detail\": \"The verification flow with id=999 was not found\",\n \"status\": 404,\n \"instance\": \"uuid\"\n}\n\nFields may include title, detail, status, instance, and other problem-specific fields.
displayName: max 30 characters
description: max 255 characters
List pageSize: min 1, max 50
{\n \"displayName\": \"Basic Phone Verification\",\n \"description\": \"Simple phone verification flow\",\n \"steps\": [\n {\n \"name\": \"LOGIN_ID\"\n },\n {\n \"name\": \"PHONE_OR_EMAIL\",\n \"settings\": {\n \"PHONE_OR_EMAIL_STEP_OTP_ENABLED\": \"true\",\n \"PHONE_OR_EMAIL_STEP_CONTACT_PREFERENCE\": \"phone\"\n }\n },\n {\n \"name\": \"OUTCOME\",\n \"settings\": {\n \"OUTCOME_STEP_RESULT\": \"DO_NOTHING\"\n }\n }\n ]\n}\n\n{\n \"displayName\": \"High-Security Verification\",\n \"description\": \"High-security flow with document verification and approvers\",\n \"steps\": [\n {\n \"name\": \"LOGIN_ID\"\n },\n {\n \"name\": \"PHONE_OR_EMAIL\",\n \"settings\": {\n \"PHONE_OR_EMAIL_STEP_OTP_ENABLED\": \"true\"\n }\n },\n {\n \"name\": \"LOCATION\"\n },\n {\n \"name\": \"DOCUMENT_BIOMETRIC\",\n \"settings\": {\n \"DOCUMENT_BIOMETRIC_STEP_DOCUMENT_AUTHENTICATION_ENABLED\": \"true\",\n \"DOCUMENT_BIOMETRIC_STEP_LIVE_PHOTO_AND_DOCUMENT_COMPARISON_ENABLED\": \"true\",\n \"DOCUMENT_BIOMETRIC_STEP_AML_CHECK_ENABLED\": \"true\"\n }\n },\n {\n \"name\": \"ATTESTATION\"\n },\n {\n \"name\": \"OUTCOME\",\n \"settings\": {\n \"OUTCOME_STEP_RESULT\": \"HYPR_DEVICE_MANAGER\"\n }\n }\n ],\n \"approvers\": [\n {\n \"email\": \"approver@example.com\",\n \"approverType\": \"SOMEONE_ELSE\"\n }\n ]\n}\n\nFor full request and response schemas, step settings by type, and field descriptions, see the individual endpoint docs in this folder.
\n","_postman_id":"477d85fb-adc5-4004-ba56-241f73253453","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Single User Workflows","item":[{"name":"Create single user workflow","id":"9ff2e7be-82f8-4013-a893-867a197081be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{CCAdminAccessToken}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"verificationFlowId\": \"12345\",\r\n \"userPii\": {\r\n \"loginId\": \"user.login@company.com\",\r\n \"email\": \"user.login@company.com\",\r\n \"firstName\": \"Jane\",\r\n \"lastName\": \"Doe\",\r\n \"phoneNumber\": \"+15551234567\",\r\n \"streetAddress\": \"123 Main St\",\r\n \"state\": \"NY\",\r\n \"countryCode\": \"US\",\r\n \"postalCode\": \"10001\",\r\n \"city\": \"New York\"\r\n },\r\n \"redirectUrl\": \"https://example.com/success\",\r\n \"failureRedirectUrl\": \"https://example.com/failure\",\r\n \"expiresOn\": \"2025-12-31T23:59:59Z\",\r\n \"approvers\": [\r\n {\r\n \"email\": \"approver@example.com\",\r\n \"phoneNumber\": \"+15559876543\",\r\n \"approverType\": \"SOMEONE_ELSE\",\r\n \"oidcClientConfigId\": null,\r\n \"inviteNextApproverAfterMinutes\": 15\r\n }\r\n ],\r\n \"escalationApprovers\": [],\r\n \"steps\": {\r\n \"phoneEmail\": {\r\n \"failureRedirectUrl\": \"https://example.com/phone-failure\"\r\n },\r\n \"location\": {\r\n \"failureRedirectUrl\": \"https://example.com/location-failure\"\r\n },\r\n \"verifiedCredential\": {\r\n \"failureRedirectUrl\": \"https://example.com/vc-failure\"\r\n },\r\n \"idv\": {\r\n \"failureRedirectUrl\": \"https://example.com/idv-failure\"\r\n },\r\n \"documentLiveness\": {\r\n \"failureRedirectUrl\": \"https://example.com/liveness-failure\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/idv/user","description":"POST {{baseUrl}}/cc/api/idv/user
Creates a new single user workflow (a verification request for one user) for a given verification flow and user. The response includes the workflow ID, href (verification link), workflowId, and expiration.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeUserFlow
Content-Type: application/json
Constraints:
\nverificationFlowId: required; must be the ID of an existing verification flow.
userPii: required; must include loginId.
{\n \"id\": \"string (optional, omit for new request)\",\n \"href\": \"string (optional)\",\n \"userId\": \"string (optional)\",\n \"workflowId\": \"string (optional)\",\n \"expiresOn\": \"string (optional, ISO-8601)\",\n \"redirectUrl\": \"string (optional)\",\n \"failureRedirectUrl\": \"string (optional)\",\n \"approvers\": [],\n \"escalationApprovers\": [],\n \"verificationFlowId\": \"string (required)\",\n \"userPii\": {\n \"loginId\": \"string (required)\",\n \"email\": \"string (optional)\",\n \"firstName\": \"string (optional)\",\n \"lastName\": \"string (optional)\",\n \"phoneNumber\": \"string (optional)\",\n \"state\": \"string (optional)\",\n \"streetAddress\": \"string (optional)\",\n \"countryCode\": \"string (optional)\",\n \"postalCode\": \"string (optional)\",\n \"city\": \"string (optional)\"\n },\n \"steps\": {\n \"phoneEmail\": { \"failureRedirectUrl\": \"string (optional)\" },\n \"location\": { \"failureRedirectUrl\": \"string (optional)\" },\n \"verifiedCredential\": { \"failureRedirectUrl\": \"string (optional)\" },\n \"idv\": { \"failureRedirectUrl\": \"string (optional)\" },\n \"documentLiveness\": { \"failureRedirectUrl\": \"string (optional)\" }\n }\n}\n\nThe response body is the created single user workflow. The server sets id, href, userId, workflowId, and expiresOn.
Content-Type: application/json
{\n \"id\": \"string\",\n \"href\": \"string\",\n \"userId\": \"string\",\n \"workflowId\": \"string\",\n \"expiresOn\": \"string\",\n \"redirectUrl\": \"string\",\n \"failureRedirectUrl\": \"string\",\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"verificationFlowId\": \"string\",\n \"userPii\": {\n \"loginId\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phoneNumber\": \"string\",\n \"state\": \"string\",\n \"streetAddress\": \"string\",\n \"countryCode\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\"\n },\n \"steps\": {\n \"phoneEmail\": { \"failureRedirectUrl\": \"string\" },\n \"location\": { \"failureRedirectUrl\": \"string\" },\n \"verifiedCredential\": { \"failureRedirectUrl\": \"string\" },\n \"idv\": { \"failureRedirectUrl\": \"string\" },\n \"documentLiveness\": { \"failureRedirectUrl\": \"string\" }\n }\n}\n\nDELETE {{baseUrl}}/cc/api/idv/user/{id}
Deletes a single user workflow by ID. The response body is the deleted single user workflow object. After a successful delete, the workflow is permanently removed.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeUserFlow
The response body is the deleted single user workflow object.
\nContent-Type: application/json
Note: Response structure is identical to the create endpoint responses. See the example responses under postman-docs/single-user-workflows/create/.
{\n \"id\": \"string\",\n \"href\": \"string\",\n \"userId\": \"string\",\n \"workflowId\": \"string\",\n \"expiresOn\": \"string\",\n \"redirectUrl\": \"string\",\n \"failureRedirectUrl\": \"string\",\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"verificationFlowId\": \"string\",\n \"userPii\": {\n \"loginId\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phoneNumber\": \"string\",\n \"state\": \"string\",\n \"streetAddress\": \"string\",\n \"countryCode\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\"\n },\n \"steps\": {\n \"phoneEmail\": { \"failureRedirectUrl\": \"string\" },\n \"location\": { \"failureRedirectUrl\": \"string\" },\n \"verifiedCredential\": { \"failureRedirectUrl\": \"string\" },\n \"idv\": { \"failureRedirectUrl\": \"string\" },\n \"documentLiveness\": { \"failureRedirectUrl\": \"string\" }\n }\n}\n\nGET {{baseUrl}}/cc/api/idv/user/{id}
Returns a single user workflow by its ID.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readUserFlow
scope: hypr:affirm:writeUserFlow
The response body is a single user workflow object.
\nContent-Type: application/json
Note: Response structure is identical to the create endpoint responses. See the example responses under postman-docs/single-user-workflows/create/.
{\n \"id\": \"string\",\n \"href\": \"string\",\n \"userId\": \"string\",\n \"workflowId\": \"string\",\n \"expiresOn\": \"string\",\n \"redirectUrl\": \"string\",\n \"failureRedirectUrl\": \"string\",\n \"approvers\": [\n {\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"approverType\": \"MANAGER | SOMEONE_ELSE | DYNAMIC | NONE\",\n \"oidcClientConfigId\": \"string\",\n \"inviteNextApproverAfterMinutes\": 0\n }\n ],\n \"escalationApprovers\": [],\n \"verificationFlowId\": \"string\",\n \"userPii\": {\n \"loginId\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phoneNumber\": \"string\",\n \"state\": \"string\",\n \"streetAddress\": \"string\",\n \"countryCode\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\"\n },\n \"steps\": {\n \"phoneEmail\": { \"failureRedirectUrl\": \"string\" },\n \"location\": { \"failureRedirectUrl\": \"string\" },\n \"verifiedCredential\": { \"failureRedirectUrl\": \"string\" },\n \"idv\": { \"failureRedirectUrl\": \"string\" },\n \"documentLiveness\": { \"failureRedirectUrl\": \"string\" }\n }\n}\n\nPOST {{baseUrl}}/cc/api/idv/user/unblock
Unblocks a single user from any workflow. Use when a user was blocked from retrying verification (e.g. after exceeding attempt limits). Send the user’s loginId and the verificationFlowId in the request body. The response indicates whether the unblock succeeded and a message.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeUserFlow
Content-Type: application/json
{\n \"loginId\": \"string (required)\",\n \"verificationFlowId\": 0\n}\n\nContent-Type: application/json
{\n \"successful\": true,\n \"message\": \"string\"\n}\n\nThe Single User Workflows API provides endpoints for creating, retrieving, deleting, and unblocking single user workflows.
\nVerification flow: A configurable template that defines the sequence of verification steps, approvers, and outcomes (e.g. onboarding, recovery). Verification flows are created and managed via the Verification Flows API. A verification flow has an ID and is reusable for many users.
\nVerification request: The act of initiating identity verification for a specific user, or the resulting instance. When you create a verification request, you choose a verification flow and supply the user’s identity data (e.g. loginId, email); the system creates a single user workflow for that user.
\nSingle user workflow: One user’s instance of a verification flow. It is the object created by a verification request: it links one user (via userPii) to one verification flow (verificationFlowId) and has its own id, href, workflowId, and expiresOn. The href is the link you send to the user to start verification. This API uses “single user workflow” for the resource you create, get, delete, or unblock.
A single user workflow:
\nLinks a user to a verification flow: It is created for a given verificationFlowId (an existing verification flow) and identifies the user via userPii (e.g. loginId, email, name, phone).
Produces a workflow ID and href: After creation, the API returns an id (workflow/request ID) and a href (URL) that can be sent to the user to start the verification.
Can be read or deleted by that ID.
\nCan be unblocked: If a user is blocked from retrying verification (e.g. after too many failures), the unblock endpoint clears the block for that user and verification flow.
\nProgrammatic onboarding: Create single user workflows for new employees and send them the verification link.
\nAccount recovery: Create a single user workflow for a user who needs to verify identity to recover access.
\nInspecting or cleaning up: Get a single user workflow by ID or delete it when no longer needed.
\nUnblocking users: Allow a user to retry verification after being blocked (e.g. after hitting attempt limits).
\nPOST {{baseUrl}}/cc/api/idv/user
Creates a new single user workflow (a verification request for one user). You must provide verificationFlowId (ID of an existing verification flow) and userPii (at least loginId; other fields such as email, firstName, lastName, phoneNumber are optional). The response includes the created workflow with id, href, workflowId, expiresOn, and other fields. The href can be used to send the user to the verification UI.
GET {{baseUrl}}/cc/api/idv/user/{id}
Returns a single user workflow by its ID (id). The path parameter id is the workflow/request ID returned when the workflow was created.
DELETE {{baseUrl}}/cc/api/idv/user/{id}
Deletes a single user workflow by ID. The response body is the deleted workflow. This action cannot be undone.
\nPOST {{baseUrl}}/cc/api/idv/user/unblock
Unblocks a single user for a specific verification flow. Use when a user was blocked from retrying verification (e.g. after exceeding attempt limits). Send loginId and verificationFlowId in the request body. The response indicates success or failure with a message.
All endpoints require a Bearer token and one of the following scopes:
\nverificationFlowId (required): ID of the verification flow to use. The flow must exist.
\nuserPii (required): User data. loginId is required; email, firstName, lastName, phoneNumber, streetAddress, state, countryCode, postalCode, city are optional. When stored, PII is encrypted at rest.
redirectUrl, failureRedirectUrl: Optional URLs used when the verification flow is configured for dynamic redirect.
\nexpiresOn: Optional expiration (ISO-8601). If omitted, server applies a default.
\napprovers, escalationApprovers: Optional overrides; must match flow constraints (e.g. dynamic approvers).
\nsteps: Optional step-level overrides (e.g. phoneEmail.failureRedirectUrl).
id: Workflow/request ID (use in GET and DELETE path).
\nhref: URL to send the user to start verification.
\nuserId, workflowId, verificationFlowId, expiresOn.
\nuserPii: User data as stored (PII is encrypted at rest).
\napprovers, escalationApprovers: Resolved approvers (email, phoneNumber, approverType, etc.).
\nredirectUrl, failureRedirectUrl, steps as applicable.
\nloginId (required): User’s login identifier.
\nverificationFlowId (required): Verification flow ID (numeric).
\nsuccessful: true if the user was unblocked, false otherwise (e.g. not found or not blocked).
message: Human-readable result.
\nErrors use RFC 7807 Problem Details (e.g. application/json). Example:
{\n \"title\": \"There was an issue with the single user workflow\",\n \"detail\": \"The single user workflow with id=xyz was not found\",\n \"status\": 404,\n \"instance\": \"uuid\"\n}\n\nFields may include title, detail, status, instance, and other problem-specific fields.
{\n \"verificationFlowId\": \"123\",\n \"userPii\": {\n \"loginId\": \"jane.doe@example.com\"\n }\n}\n\n{\n \"verificationFlowId\": \"123\",\n \"userPii\": {\n \"loginId\": \"jane.doe@example.com\",\n \"email\": \"jane.doe@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+15551234567\"\n },\n \"redirectUrl\": \"https://myapp.example.com/success\",\n \"failureRedirectUrl\": \"https://myapp.example.com/failed\"\n}\n\n{\n \"loginId\": \"jane.doe@example.com\",\n \"verificationFlowId\": 123\n}\n\nFor full request and response schemas and field descriptions, see the individual endpoint docs in this folder.
\n","_postman_id":"c9b17aa0-fded-48e3-a11e-9465aa7d1a9f","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Workflow Management","item":[{"name":"Get workflow by ID","id":"f68b0160-4a6f-4e92-b2df-c34869c68a5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{CCAdminAccessToken}}"},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/idv/workflow/:workflowId","description":"GET {{baseUrl}}/cc/api/idv/workflow/{id}
Returns workflow metadata for the given workflow ID (completion status, result, requestor/approver IDs, and linked user verification request ID).
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readWorkflow
The response body is a workflow object.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"userVerificationRequestId\": \"string\",\n \"isCompleted\": false,\n \"result\": \"SUCCESS | FAILURE | NONE\",\n \"createdOn\": \"string\",\n \"requestorUserId\": \"string\",\n \"approverUserId\": \"string\"\n}\n\nSee the Documentation tab.
\n","type":"text/plain"},"type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"af0c2488-8176-4175-b64f-de198e7f96d4","name":"200 OK - Completed","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/cc/api/idv/workflow/:workflowId","host":["{{baseUrl}}"],"path":["cc","api","idv","workflow",":workflowId"],"variable":[{"key":"workflowId","value":"workflow-instance-abc","description":"See the Documentation tab."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"workflow-instance-abc\",\n \"userVerificationRequestId\": \"usr-wf-789\",\n \"isCompleted\": true,\n \"result\": \"SUCCESS\",\n \"createdOn\": \"2025-02-01T10:00:00Z\",\n \"requestorUserId\": \"user-internal-id-456\",\n \"approverUserId\": \"approver-internal-id-123\"\n}\n"},{"id":"c90a92e7-4774-4244-8ccb-a341b1db0505","name":"200 OK - Failed","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/cc/api/idv/workflow/:workflowId","host":["{{baseUrl}}"],"path":["cc","api","idv","workflow",":workflowId"],"variable":[{"key":"workflowId","value":"workflow-instance-ghi","description":"See the Documentation tab."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"workflow-instance-ghi\",\n \"userVerificationRequestId\": \"usr-wf-791\",\n \"isCompleted\": true,\n \"result\": \"FAILURE\",\n \"createdOn\": \"2025-02-05T14:00:00Z\",\n \"requestorUserId\": \"user-internal-id-458\",\n \"approverUserId\": null\n}\n"},{"id":"861fb817-3e99-4212-a916-a62b16f6db9a","name":"200 OK - Incomplete","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/cc/api/idv/workflow/:workflowId","host":["{{baseUrl}}"],"path":["cc","api","idv","workflow",":workflowId"],"variable":[{"key":"workflowId","value":"workflow-instance-def","description":"See the Documentation tab."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"workflow-instance-def\",\n \"userVerificationRequestId\": \"usr-wf-790\",\n \"isCompleted\": false,\n \"result\": \"NONE\",\n \"createdOn\": \"2025-02-06T08:30:00Z\",\n \"requestorUserId\": \"user-internal-id-457\",\n \"approverUserId\": null\n}\n"}],"_postman_id":"f68b0160-4a6f-4e92-b2df-c34869c68a5c"},{"name":"Get workflow results","id":"caca223a-ef11-4d05-90af-177683ec3ded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{CCAdminAccessToken}}"},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}cc/api/idv/workflow/:workflowId/results","description":"GET {{baseUrl}}/cc/api/idv/workflow/{id}/results
Returns detailed activity log details for the given workflow (step statuses, locations, approver decision, requester/approver info, and optional no-PII aggregated results).
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readWorkflow
The response body is an activity log details object.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"requester\": \"string\",\n \"date\": \"string (ISO-8601 instant)\",\n \"workflowType\": \"ONBOARDING | RECOVERY | CC_ADMIN | CUSTOM\",\n \"smsSendTime\": \"string (ISO-8601 instant) | null\",\n \"phoneStepStatus\": \"PASS | FAILED | NOT_CONFIGURED | NOT_ASSOCIATED\",\n \"ipLocation\": \"string | null\",\n \"browserLocation\": \"string | null\",\n \"identityVerificationLivenessCheck\": \"PASS | FAILED | NOT_CONFIGURED | NOT_ASSOCIATED\",\n \"noPiiAggregatedResults\": \"object | null\",\n \"photoIdAndLivenessCapture\": \"PASS | FAILED | NOT_CONFIGURED | NOT_ASSOCIATED\",\n \"approverChatAndVideo\": \"PASS | FAILED | NOT_CONFIGURED | NOT_ASSOCIATED\",\n \"approver\": \"string\",\n \"decision\": \"APPROVED | NOT_ASSOCIATED | DENIED\",\n \"approverNotes\": \"string | null\",\n \"location\": {\n \"ipLocation\": { \"value\": 0, \"unit\": \"METERS\", \"lat\": 0, \"long\": 0 },\n \"browserLocation\": { \"value\": 0, \"unit\": \"METERS\", \"lat\": 0, \"long\": 0 }\n },\n \"workflowCode\": \"string\"\n}\n\nThe Workflow Management API provides endpoints for querying identity verification workflow instances by ID. It allows you to retrieve workflow metadata (status, completion, result, requestor/approver) and detailed activity results for a given workflow.
\nBase path: {{baseUrl}}/cc/api/idv/workflow
Workflow (instance): A single run of an identity verification flow for one user. It has a unique id (workflow ID). Workflows are created via the User Verification Requests API (single user workflows). This API lets you query an existing workflow by that ID.
Workflow result: The outcome of a workflow: SUCCESS, FAILURE, or NONE (e.g. not yet completed or no attestation).
Get workflow by ID: Retrieve workflow metadata (id, completion status, result, requestor/approver IDs, linked user verification request ID).
\nGet workflow results: Retrieve detailed activity log details for a workflow (step statuses, locations, approver decision, etc.).
\nStatus checks: Determine whether a workflow is completed and whether the result was success or failure.
\nAudit and reporting: Fetch detailed results (e.g. step outcomes, locations, approver notes) for a specific workflow.
\nLinking to user requests: Use the returned userVerificationRequestId to correlate with the User Verification Requests API.
GET {{baseUrl}}/cc/api/idv/workflow/{id}
Returns a summary of one workflow instance by its workflow ID. Use this when you need to know whether a workflow is completed, its outcome (success, failure, or none), when it was created, who the requestor and approver are (by anonymous ID), and the associated user verification request ID if any. The path parameter id is the workflow ID (the same value as workflowId returned when you create a single user workflow via the User Verification Requests API). The response includes id, userVerificationRequestId, isCompleted, result (SUCCESS, FAILURE, or NONE), createdOn, requestorUserId, and approverUserId. Typical use: dashboards, status checks, or looking up the verification request that created this workflow.
GET {{baseUrl}}/cc/api/idv/workflow/{id}/results
Returns the full activity log details for one workflow. Use this when you need a step-by-step audit of what happened: requester and approver identifiers, workflow type and date, status of each verification step (phone/email, location, identity verification liveness and name check, photo ID and liveness, approver chat/video), the approver’s decision (approved, denied, or not associated), approver notes, IP and browser location data, and optional no-PII aggregated report results. The path parameter id is the same workflow ID as in GET .../workflow/{id}. Typical use: compliance audits, support investigations, and detailed reporting on why a workflow succeeded or failed.
All endpoints require a Bearer token and one of the following scopes:
\nresult)workflowType)decision)*StepStatus fields)location.*.unit)Errors are returned as application/problem+json. Example:
{\n \"type\": \"https://docs.hypr.com/problems/workflow-problem\",\n \"title\": \"There was an issue with the workflow\",\n \"status\": 404,\n \"detail\": \"The workflow with id=workflow-instance-abc was not found\",\n \"instance\": \"/cc/api/idv/workflow/workflow-instance-abc\"\n}\nPOST {{baseUrl}}/cc/api/idv/code-customization
Creates a new identity verification code customization.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeCodeCustomization
Content-Type: application/json
Request body is a CodeCustomizationRequest.
\n{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"type\": \"string\",\n \"content\": \"string\",\n \"attributes\": {}\n}\n\nOn success the response body is the created code customization (includes the generated id). Attribute values are not returned; only attributes as a list of keys.
Content-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"type\": \"string\",\n \"content\": \"string\",\n \"attributes\": [\"string\"]\n}\n\nDELETE {{baseUrl}}/cc/api/idv/code-customization/{id}
Deletes a code customization by ID. The response body is the deleted code customization object. Workflows that referenced this customization are updated (e.g. disabled or reference removed).
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeCodeCustomization
The response body is the deleted code customization object (same structure as returned by GET by ID).
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"type\": \"string\",\n \"content\": \"string\",\n \"attributes\": [\"string\"]\n}\n\nDeletion is permanent. Any verification flow that referenced this code customization will have that reference removed or the flow disabled.
\nUse a valid numeric code customization ID. Invalid or non-numeric IDs result in 404 with an RFC 7807 problem detail body.
\nRequest
\nDELETE {{baseUrl}}/cc/api/idv/code-customization/42
Headers
\nResponse (200)
\n{\n \"id\": \"42\",\n \"displayName\": \"User Directory Image Writeback\",\n \"description\": \"Write user images back to directory after verification\",\n \"type\": \"USER_DIRECTORY_IMAGE_WRITEBACK\",\n \"content\": \"BASE64_OR_SCRIPT_CONTENT\",\n \"attributes\": [\n \"endpointUrl\",\n \"apiKey\"\n ]\n}\nRequest
\nDELETE {{baseUrl}}/cc/api/idv/code-customization/999999
Response (404, application/problem+json)
{\n \"type\": \"about:blank\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"Code customization not found\",\n \"error\": 1200\n}\nGET {{baseUrl}}/cc/api/idv/code-customization/{id}
Returns a single code customization by ID.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readCodeCustomization
scope: hypr:affirm:writeCodeCustomization
The response body is a single code customization object.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"type\": \"string\",\n \"content\": \"string\",\n \"attributes\": [\"string\"]\n}\n\nid must be a valid numeric ID (e.g. as returned from POST create or GET list).
Invalid or non-numeric IDs result in 404 with an RFC 7807 problem detail body.
\nGET {{baseUrl}}/cc/api/idv/code-customization
Returns all code customizations. No query or path parameters.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readCodeCustomization
scope: hypr:affirm:writeCodeCustomization
The response body is a JSON array of code customization objects.
\nContent-Type: application/json
[\n {\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"type\": \"string\",\n \"content\": \"string\",\n \"attributes\": [\"string\"]\n }\n]\n\nPOST {{baseUrl}}/cc/api/idv/code-customization/test
Runs a code customization with the provided test input. Returns the execution result and logs (e.g. for debugging or validation). The customization is not modified.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeCodeCustomization
scope: hypr:affirm:testCodeCustomization
Content-Type: application/json
Request body is a CodeCustomizationTestRequest.
\n{\n \"id\": \"string\",\n \"input\": {}\n}\n\nThe response body is the run result and optional logs.
\nContent-Type: application/json
{\n \"result\": {},\n \"logs\": [\"string\"]\n}\n\nid must reference an existing code customization. The customization is executed in a test context; no persistent state is changed.
The shape of input and result depends on the customization type (e.g. user directory, SMS send/verify, email send, outcome API call). See workflow or type-specific documentation for expected keys.
POST {{baseUrl}}/cc/api/idv/code-customization/update
Updates an existing code customization. Only provided fields are updated; omitted fields retain their current values.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeCodeCustomization
Content-Type: application/json
Request body is a CodeCustomizationUpdateRequest. Include id to identify the customization; send only the fields you want to change.
{\n \"id\": \"string\",\n \"content\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"setAttributes\": {},\n \"deleteAttributes\": [\"string\"]\n}\n\nThe response body is the updated code customization (full object including id). Attribute values are not returned; only attributes as a list of keys.
Content-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"type\": \"string\",\n \"content\": \"string\",\n \"attributes\": [\"string\"]\n}\n\nResponse fields match the structure in Get code customization; attributes is the list of remaining attribute keys after any setAttributes and deleteAttributes are applied.
id in the request body must match an existing code customization (valid numeric ID).
setAttributes merges with existing attributes; deleteAttributes removes the listed keys.
The Code Customization API provides endpoints for creating, reading, updating, deleting, and testing identity verification (IDV) code customizations. Code customizations are executable logic (e.g. user directory lookups, SMS/email send/verify, outcome API calls) that can be attached to verification flows via workflow configuration codeCustomizations.
Base path: {{baseUrl}}/cc/api/idv/code-customization
A code customization includes:
\ndisplayName – Name for the customization (e.g. for admin UI)
\ndescription – Optional description
\ntype – One of: USER_DIRECTORY_SOURCE, USER_DIRECTORY_FOR_PHONE_NUMBER_ATTRIBUTE_SOURCE, USER_DIRECTORY_FOR_EMAIL_ATTRIBUTE_SOURCE, SMS_SEND, SMS_VERIFY, EMAIL_SEND, OUTCOME_API_CALL
content – Code content (e.g. base64 or script)
\nattributes – Key-value map of encrypted attributes used by the code at runtime
\nUser directory – Custom logic to resolve users from a directory (by ID or by phone/email attribute)
\nSMS / Email – Custom send and verify logic for OTP or notifications
\nOutcome – Custom API call when a verification completes
\nReuse – Attach one code customization to multiple verification flows via workflow codeCustomizations
GET {{baseUrl}}/cc/api/idv/code-customization
Returns an array of all code customization objects. No query parameters.
\nPOST {{baseUrl}}/cc/api/idv/code-customization
Creates a new code customization. Request body is CodeCustomizationRequest (displayName, description, type, content, attributes). Response is the created object (includes id). Returns 200 on success.
GET {{baseUrl}}/cc/api/idv/code-customization/{id}
Returns a single code customization by ID. Path parameter id must be a valid numeric ID. Returns 404 if not found.
DELETE {{baseUrl}}/cc/api/idv/code-customization/{id}
Deletes a code customization by ID. Response body is the deleted object. Workflows that referenced this customization are updated (e.g. disabled or reference removed). Returns 404 if the ID is invalid or not found.
\nPOST {{baseUrl}}/cc/api/idv/code-customization/update
Updates an existing code customization. Request body is CodeCustomizationUpdateRequest (id, content, displayName, description, setAttributes, deleteAttributes). Returns the updated object. Returns 404 if the ID is invalid or not found.
POST {{baseUrl}}/cc/api/idv/code-customization/test
Runs a code customization with the provided test input. Request body is CodeCustomizationTestRequest (id, input). Response is the run result and logs. Returns 404 if the customization ID is not found.
All endpoints require a Bearer token. Required scope depends on the operation:
\nWrite (POST create, POST update, DELETE): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, or scope: hypr:affirm:writeCodeCustomization.
Read (GET list, GET by id): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, scope: hypr:affirm:readCodeCustomization, or scope: hypr:affirm:writeCodeCustomization.
Test (POST test): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, scope: hypr:affirm:writeCodeCustomization, or scope: hypr:affirm:testCodeCustomization.
Success responses use Content-Type: application/json.
Errors use Content-Type: application/problem+json (RFC 7807). Typical status codes: 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 500 (Internal Server Error).
Verification Flows API overview – Attach code customizations to a flow via codeCustomizations.
Individual endpoint docs: Get all, Create, Get by ID, Delete, Update, Test (Code Customization API Postman).
\nJWT token with CC_ADMIN_APP_MODIFY authority
\n"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Corporate IDV theme (full)\",\n \"description\": \"Branded content and styles – all documented fields.\",\n \"contentMap\": {\n \"instructionsScreen\": {\n \"cardHeader\": {\n \"title\": \"Verify your identity\",\n \"description\": \"Complete the following steps.\"\n },\n \"cardFooter\": {\n \"caption1\": \"Footer caption 1\",\n \"caption2\": \"Footer caption 2\"\n },\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {\n \"fetchInstructionsFailed\": \"Failed to load\",\n \"loadingInstructionsError\": \"Loading error\"\n },\n \"screenSpecificContent\": {\n \"verifyPhoneStepLabel\": \"Verify phone\",\n \"verifyLocationStepLabel\": \"Verify location\",\n \"verifyIdDocumentationStepLabel\": \"Verify ID document\",\n \"loadingPlaceholder\": \"Loading...\"\n }\n },\n \"consentScreen\": {\n \"cardHeader\": {\n \"title\": \"Consent\",\n \"description\": \"Please agree to continue.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"I agree\"\n },\n \"errorMessages\": {},\n \"screenSpecificContent\": {\n \"loadingPlaceholder\": \"Loading...\"\n }\n },\n \"loginIdentifierScreen\": {\n \"cardHeader\": {\n \"title\": \"Enter your login\",\n \"description\": \"Use your sign-in identifier.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {\n \"unknown\": \"An error occurred\"\n },\n \"fieldRelatedContent\": {\n \"loginIdentifierPlaceholder\": \"Email or username\"\n },\n \"screenSpecificContent\": {}\n },\n \"phoneNumberOrEmailScreen\": {\n \"cardHeader\": {\n \"title\": \"Verify contact\",\n \"description\": \"We'll send a verification code.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Send code\"\n },\n \"errorMessages\": {\n \"invalidPhoneNumber\": \"Invalid phone\",\n \"invalidEmail\": \"Invalid email\"\n },\n \"fieldRelatedContent\": {\n \"phoneNumberPlaceholder\": \"Phone number\",\n \"emailPlaceholder\": \"Email address\"\n },\n \"screenSpecificContent\": {}\n },\n \"otpScreen\": {\n \"cardHeader\": {\n \"title\": \"Enter code\",\n \"description\": \"Enter the code we sent.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Continue\",\n \"verifyButton\": \"Verify\",\n \"resendButton\": \"Resend code\"\n },\n \"errorMessages\": {\n \"codeNotSent\": \"Code not sent\",\n \"codeMismatchTitle\": \"Invalid code\",\n \"invalid\": \"Invalid code\"\n },\n \"successMessages\": {\n \"verified\": \"Verified successfully\"\n },\n \"screenSpecificContent\": {}\n },\n \"locationScreen\": {\n \"cardHeader\": {\n \"title\": \"Verify location\",\n \"description\": \"We'll check your location.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {},\n \"successMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"verifiedCredentialScreen\": {\n \"cardHeader\": {\n \"title\": \"Verified credential\",\n \"description\": \"Present your credential.\"\n },\n \"cardFooter\": {\n \"caption1\": \"\",\n \"caption2\": \"\"\n },\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"idv1Screen\": {\n \"cardHeader\": {\n \"title\": \"Verify identity\",\n \"description\": \"Document and biometric verification.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"idv1AwaitScreen\": {\n \"cardHeader\": {\n \"title\": \"Processing\",\n \"description\": \"Please wait.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {},\n \"errorMessages\": {},\n \"screenSpecificContent\": {\n \"loadingPlaceholder\": \"Processing...\"\n }\n },\n \"idv1ReportScreen\": {\n \"cardHeader\": {\n \"title\": \"Report\",\n \"description\": \"Verification report.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"documentUploadVideoScreen\": {\n \"cardHeader\": {\n \"title\": \"Upload document\",\n \"description\": \"Follow the video instructions.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n },\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"awaitScreen\": {\n \"cardHeader\": {\n \"title\": \"Please wait\",\n \"description\": \"Processing your request.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {},\n \"errorMessages\": {},\n \"screenSpecificContent\": {\n \"loadingPlaceholder\": \"Loading...\"\n }\n },\n \"approverPreVerifyScreen\": {\n \"cardHeader\": {\n \"title\": \"Pre-verification\",\n \"description\": \"Before approver review.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {},\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"approverAttestScreen\": {\n \"cardHeader\": {\n \"title\": \"Approver attestation\",\n \"description\": \"Approve or deny the request.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {\n \"continueButton\": \"Approve\",\n \"verifyButton\": \"Deny\"\n },\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n },\n \"approverAttestationResultsScreen\": {\n \"cardHeader\": {\n \"title\": \"Attestation results\",\n \"description\": \"Outcome of the review.\"\n },\n \"cardFooter\": {},\n \"buttonLabels\": {},\n \"errorMessages\": {},\n \"screenSpecificContent\": {}\n }\n },\n \"stylePaletteMap\": {\n \"fullScreenExperience\": true,\n \"headerBackground\": \"#1a1a2e\",\n \"logoWidth\": \"120px\",\n \"logoHeight\": \"40px\",\n \"bodyContentColor\": \"#333333\",\n \"bodyContentSize\": \"16px\",\n \"headingContentColor\": \"#1a1a2e\",\n \"headingContentSize\": \"24px\",\n \"colorProgressTrack\": \"#e0e0e0\",\n \"colorProgressIndicator\": \"#0066cc\",\n \"primaryButtonBackgroundColor\": \"#0066cc\",\n \"primaryButtonTextColor\": \"#ffffff\",\n \"primaryButtonHoverBackgroundColor\": \"#0052a3\",\n \"primaryButtonFocusBackgroundColor\": \"#004080\",\n \"primaryButtonBorder\": \"1px solid\",\n \"primaryButtonBorderColor\": \"#0066cc\",\n \"primaryButtonHoverBorderColor\": \"#0052a3\",\n \"primaryButtonFocusBorderColor\": \"#004080\",\n \"primaryButtonBorderRadius\": \"4px\",\n \"primaryButtonDisabledBackgroundColor\": \"#cccccc\",\n \"primaryButtonDisabledTextColor\": \"#666666\",\n \"primaryButtonDisabledBorderColor\": \"#999999\",\n \"secondaryButtonBackgroundColor\": \"#ffffff\",\n \"secondaryButtonTextColor\": \"#0066cc\",\n \"secondaryButtonHoverBackgroundColor\": \"#f0f0f0\",\n \"secondaryButtonFocusBackgroundColor\": \"#e8e8e8\",\n \"secondaryButtonBorder\": \"1px solid\",\n \"secondaryButtonBorderColor\": \"#0066cc\",\n \"secondaryButtonHoverBorderColor\": \"#0052a3\",\n \"secondaryButtonFocusBorderColor\": \"#004080\",\n \"secondaryButtonBorderRadius\": \"4px\",\n \"secondaryButtonDisabledBackgroundColor\": \"#f5f5f5\",\n \"secondaryButtonDisabledTextColor\": \"#999999\",\n \"secondaryButtonDisabledBorderColor\": \"#cccccc\",\n \"tertiaryButtonBackgroundColor\": \"transparent\",\n \"tertiaryButtonTextColor\": \"#0066cc\",\n \"tertiaryButtonHoverBackgroundColor\": \"#f0f0f0\",\n \"tertiaryButtonFocusBackgroundColor\": \"#e8e8e8\",\n \"tertiaryButtonBorder\": \"1px solid\",\n \"tertiaryButtonBorderColor\": \"#0066cc\",\n \"tertiaryButtonHoverBorderColor\": \"#0052a3\",\n \"tertiaryButtonFocusBorderColor\": \"#004080\",\n \"tertiaryButtonBorderRadius\": \"4px\",\n \"tertiaryButtonDisabledBackgroundColor\": \"transparent\",\n \"tertiaryButtonDisabledTextColor\": \"#999999\",\n \"tertiaryButtonDisabledBorderColor\": \"#cccccc\",\n \"inputBackgroundColor\": \"#ffffff\",\n \"inputContentColor\": \"#333333\",\n \"inputBorderColor\": \"#cccccc\",\n \"videoLogoWidth\": \"100px\",\n \"videoHeadingContentColor\": \"#1a1a2e\",\n \"videoHeadingContentSize\": \"20px\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/idv/content-customization","description":"POST {{baseUrl}}/cc/api/idv/content-customization
Creates a new identity verification content customization kit.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
Content-Type: application/json
Request body is a BaseContentCustomizationDTO.
\ndisplayName is required and validated by the server.
{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nstylePaletteMap controls the visual theme of the IDV flow: header, logo, typography, progress bar, buttons, inputs, and video area. All keys are optional; omitted keys fall back to defaults. Values are typically CSS-friendly strings (e.g. hex colors like #ffffff, sizes like 16px, 1rem).
Layout and header
\nBody and headings
\nProgress bar
\nPrimary button (main CTAs)
\nSecondary button
\nTertiary button
\nInput fields
\nVideo area (e.g. document upload / instructions video)
\nThe server uses stylePaletteMap to generate a CSS stylesheet (e.g. via the stylesheet endpoint). Only keys you override need to be present; the rest use default theme values.
contentMap holds copy and labels for each IDV screen. It is an object whose keys are screen names; each screen key maps to a screen content object. All keys are optional; only screens you customize need entries.
Screen keys in contentMap
\nStructure of each screen object
\nEach screen value is an object that can contain:
\nExample: contentMap.instructionsScreen can have cardHeader (title, description), buttonLabels.continueButton, errorMessages (e.g. fetchInstructionsFailed, loadingInstructionsError), and screenSpecificContent with keys like verifyPhoneStepLabel, verifyLocationStepLabel, verifyIdDocumentationStepLabel, loadingPlaceholder. Other screens follow the same pattern with their own button, error, and screen-specific keys. Omitted screens or omitted keys within a screen use server defaults. String values may be sanitized (e.g. XSS) when stored.
On success the response body is the created content customization (ContentCustomizationDTO), including the generated id.
Content-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nContent and style values may be sanitized (e.g. XSS) before storage.
\nUse GET {{baseUrl}}/cc/api/idv/content-customization/defaults to obtain a default kit to use as a template.
DELETE {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}
Deletes a single content customization kit by ID.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
On success, the response body is the deleted ContentCustomizationDTO.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nDELETE {{baseUrl}}/cc/api/idv/content-customization
Deletes all IDV content customization kits.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
On success, the response has no body.
\nPUT {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/duplicate
Duplicates an existing content customization kit and returns the newly created kit (with a new id).
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
On success, the response body is the duplicated ContentCustomizationDTO.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nGET {{baseUrl}}/cc/api/idv/content-customization/defaults
Returns the default HYPR content customization (default copy and style). Useful as a template for creating new kits or for reference.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
The response body is a ContentCustomizationDTO with default contentMap and stylePaletteMap. The id may be null or omitted for defaults.
Content-Type: application/json
{\n \"id\": \"string | null\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nstylePaletteMap controls the visual theme of the IDV flow: header, logo, typography, progress bar, buttons, inputs, and video area. All keys are optional; omitted keys fall back to defaults. Values are typically CSS-friendly strings (e.g. hex colors like #ffffff, sizes like 16px, 1rem).
Layout and header
\nBody and headings
\nProgress bar
\nPrimary button (main CTAs)
\nSecondary button
\nTertiary button
\nInput fields
\nVideo area (e.g. document upload / instructions video)
\nThe server uses stylePaletteMap to generate a CSS stylesheet (e.g. via the stylesheet endpoint). Only keys you override need to be present; the rest use default theme values.
contentMap holds copy and labels for each IDV screen. It is an object whose keys are screen names; each screen key maps to a screen content object. All keys are optional; only screens you customize need entries.
Screen keys in contentMap
\nStructure of each screen object
\nEach screen value is an object that can contain:
\nExample: contentMap.instructionsScreen can have cardHeader (title, description), buttonLabels.continueButton, errorMessages (e.g. fetchInstructionsFailed, loadingInstructionsError), and screenSpecificContent with keys like verifyPhoneStepLabel, verifyLocationStepLabel, verifyIdDocumentationStepLabel, loadingPlaceholder. Other screens follow the same pattern with their own button, error, and screen-specific keys. Omitted screens or omitted keys within a screen use server defaults. Default copy may include a support email from server configuration where applicable. String values may be sanitized (e.g. XSS) when stored.
Use this response as a base when creating a new content customization via POST {{baseUrl}}/cc/api/idv/content-customization.
Default copy may include a support email from server configuration where applicable.
\nGET {{baseUrl}}/cc/api/idv/content-customization/defaults/style
Returns the default HYPR style palette map (stylePaletteMap) used for IDV content customization kits.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
On success, the response body is a style palette map object.
\nContent-Type: application/json
{\n \"fullScreenExperience\": true,\n \"headerBackground\": \"#ffffff\"\n}\n\nKeys are the same stylePaletteMap keys used on create/get/patch responses.
GET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}
Returns a single content customization by ID.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
The response body is a single ContentCustomizationDTO object.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nstylePaletteMap controls the visual theme of the IDV flow: header, logo, typography, progress bar, buttons, inputs, and video area. All keys are optional; omitted keys fall back to defaults. Values are typically CSS-friendly strings (e.g. hex colors like #ffffff, sizes like 16px, 1rem).
Layout and header
\nBody and headings
\nProgress bar
\nPrimary button (main CTAs)
\nSecondary button
\nTertiary button
\nInput fields
\nVideo area (e.g. document upload / instructions video)
\nThe server uses stylePaletteMap to generate a CSS stylesheet (e.g. via the stylesheet endpoint). Only keys you override need to be present; the rest use default theme values.
contentMap holds copy and labels for each IDV screen. It is an object whose keys are screen names; each screen key maps to a screen content object. All keys are optional; only screens you customize need entries.
Screen keys in contentMap
\nStructure of each screen object
\nEach screen value is an object that can contain:
\nExample: contentMap.instructionsScreen can have cardHeader (title, description), buttonLabels.continueButton, errorMessages (e.g. fetchInstructionsFailed, loadingInstructionsError), and screenSpecificContent with keys like verifyPhoneStepLabel, verifyLocationStepLabel, verifyIdDocumentationStepLabel, loadingPlaceholder. Other screens follow the same pattern with their own button, error, and screen-specific keys. Omitted screens or omitted keys within a screen use server defaults. String values may be sanitized (e.g. XSS) when stored.
contentCustomizationId must be a valid numeric ID (e.g. as returned from POST create or GET list).
Invalid or non-numeric IDs result in 404 with an RFC 7807 problem detail body.
\nGET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/screens/{screenName}
Returns the stored content JSON for a single screen in the content customization kit.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
On success, the response body is a JSON object whose shape depends on screenName. It corresponds to the inner per-screen map stored for that screen (e.g. cardHeader, buttonLabels, errorMessages, etc.).
Content-Type: application/json
{\n \"cardHeader\": {\n \"title\": \"Verify your identity\",\n \"description\": \"Complete the following steps.\"\n },\n \"buttonLabels\": {\n \"continueButton\": \"Continue\"\n }\n}\n\nscreenName)instructionsScreen
consentScreen
loginIdentifierScreen
phoneNumberOrEmailScreen
otpScreen
locationScreen
verifiedCredentialScreen
idv1Screen
idv1DobScreen
idv1AwaitScreen
idv1ReportScreen
documentUploadVideoScreen
awaitScreen
approverPreVerifyScreen
approverAttestScreen
approverAttestationResultsScreen
GET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/screens
Returns the list of screen names available for a given content customization kit.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
On success, the response body is an array of strings.
\nContent-Type: application/json
[\n \"instructionsScreen\"\n]\n\nscreenName)The {screenName} values are fixed and case-sensitive:
instructionsScreenconsentScreenloginIdentifierScreenphoneNumberOrEmailScreenotpScreenlocationScreenverifiedCredentialScreenidv1Screenidv1DobScreenidv1AwaitScreenidv1ReportScreendocumentUploadVideoScreenawaitScreenapproverPreVerifyScreenapproverAttestScreenapproverAttestationResultsScreenGET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/stylesheet
Returns a structured stylesheet representation for the content customization’s stylePaletteMap (desktop + mobile palettes).
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
| Parameter | Type | Required | Description |
| --- | --- | --- |
| contentCustomizationId | string | Yes | Content customization ID (numeric string). |
The response body is JSON containing two palettes: desktop and mobile. It is derived from the content customization’s stylePaletteMap (and default palette where values are not set). contentMap is not used to generate the stylesheet; only stylePaletteMap drives it.
Content-Type: application/json
JSON object with desktop and mobile palettes, e.g.:
{\n \"desktop\": {},\n \"mobile\": {}\n}\n\nThe stylesheet is generated from the content customization’s stylePaletteMap. That object controls the visual theme: header, logo, typography, progress bar, buttons, inputs, and video area. All keys are optional; omitted keys use default theme values. Values are typically CSS-friendly strings (e.g. hex colors like #ffffff, sizes like 16px, 1rem).
Layout and header
\nBody and headings
\nProgress bar
\nPrimary button (main CTAs)
\nSecondary button
\nTertiary button
\nInput fields
\nVideo area (e.g. document upload / instructions video)
\nTo inspect or edit the palette for a content customization, use GET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId} (response includes full stylePaletteMap and contentMap).
This endpoint is available on both the API base path (/cc/api/idv/content-customization/...) and the UI base path (/cc/ui/idv/content-customization/...).
The stylesheet is generated from the kit’s stylePaletteMap; use GET {contentCustomizationId} to inspect or edit the palette.
Invalid or non-numeric contentCustomizationId may result in 404 with an RFC 7807 problem detail body when the response is JSON.
GET {{baseUrl}}/cc/api/idv/content-customization
Returns all content customization kits. No query or path parameters.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readContentCustomization
scope: hypr:affirm:writeContentCustomization
The response body is a JSON array of ContentCustomizationDTO objects.
\nContent-Type: application/json
[\n {\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n }\n]\n\nstylePaletteMap controls the visual theme of the IDV flow: header, logo, typography, progress bar, buttons, inputs, and video area. All keys are optional; omitted keys fall back to defaults. Values are typically CSS-friendly strings (e.g. hex colors like #ffffff, sizes like 16px, 1rem).
Layout and header
\nBody and headings
\nProgress bar
\nPrimary button (main CTAs)
\nSecondary button
\nTertiary button
\nInput fields
\nVideo area (e.g. document upload / instructions video)
\nThe server uses stylePaletteMap to generate a CSS stylesheet (e.g. via the stylesheet endpoint). Only keys you override need to be present; the rest use default theme values.
contentMap holds copy and labels for each IDV screen. It is an object whose keys are screen names; each screen key maps to a screen content object. All keys are optional; only screens you customize need entries.
Screen keys in contentMap
\nStructure of each screen object
\nEach screen value is an object that can contain:
\nExample: contentMap.instructionsScreen can have cardHeader (title, description), buttonLabels.continueButton, errorMessages (e.g. fetchInstructionsFailed, loadingInstructionsError), and screenSpecificContent with keys like verifyPhoneStepLabel, verifyLocationStepLabel, verifyIdDocumentationStepLabel, loadingPlaceholder. Other screens follow the same pattern with their own button, error, and screen-specific keys. Omitted screens or omitted keys within a screen use server defaults. String values may be sanitized (e.g. XSS) when stored.
PATCH {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}
Updates an existing content customization. Only provided fields are updated; omitted fields retain their current values.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
Content-Type: application/json
Request body is a BaseContentCustomizationDTO. Send only the fields you want to change.
\n{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nstylePaletteMap controls the visual theme of the IDV flow: header, logo, typography, progress bar, buttons, inputs, and video area. All keys are optional; omitted keys fall back to defaults. Values are typically CSS-friendly strings (e.g. hex colors like #ffffff, sizes like 16px, 1rem).
Layout and header
\nBody and headings
\nProgress bar
\nPrimary button (main CTAs)
\nSecondary button
\nTertiary button
\nInput fields
\nVideo area (e.g. document upload / instructions video)
\nThe server uses stylePaletteMap to generate a CSS stylesheet (e.g. via the stylesheet endpoint). Only keys you override need to be present; the rest use default theme values.
contentMap holds copy and labels for each IDV screen. It is an object whose keys are screen names; each screen key maps to a screen content object. All keys are optional; only screens you customize need entries.
Screen keys in contentMap
\nStructure of each screen object
\nEach screen value is an object that can contain:
\nExample: contentMap.instructionsScreen can have cardHeader (title, description), buttonLabels.continueButton, errorMessages (e.g. fetchInstructionsFailed, loadingInstructionsError), and screenSpecificContent with keys like verifyPhoneStepLabel, verifyLocationStepLabel, verifyIdDocumentationStepLabel, loadingPlaceholder. Other screens follow the same pattern with their own button, error, and screen-specific keys. Omitted screens or omitted keys within a screen use server defaults. String values may be sanitized (e.g. XSS) when stored.
The response body is the updated ContentCustomizationDTO (full object including id).
Content-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nResponse fields match the request; contentMap and stylePaletteMap use the same structure as in stylePaletteMap and contentMap above.
contentCustomizationId in the path must match an existing content customization (valid numeric ID).
Content and style values may be sanitized (e.g. XSS) before storage.
\nPATCH {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/metadata
Updates only the kit metadata (displayName, description) for an existing content customization.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
Content-Type: application/json
Request body is UpdateKitMetadataDTO.
\n{\n \"displayName\": \"string\",\n \"description\": \"string\"\n}\n\nOn success, the response body is the updated ContentCustomizationDTO.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"contentMap\": {},\n \"stylePaletteMap\": {}\n}\n\nPUT {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/screens/{screenName}
Replaces the stored content JSON for a single screen in the content customization kit.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeContentCustomization
Content-Type: application/json
Request body is the JSON object representing the per-screen content for {screenName}.
{\n \"cardHeader\": {\n \"title\": \"Verify your identity (updated)\"\n }\n}\n\nscreenName)instructionsScreenconsentScreenloginIdentifierScreenphoneNumberOrEmailScreenotpScreenlocationScreenverifiedCredentialScreenidv1Screenidv1DobScreenidv1AwaitScreenidv1ReportScreendocumentUploadVideoScreenawaitScreenapproverPreVerifyScreenapproverAttestScreenapproverAttestationResultsScreenOn success, the server returns an empty response body.
\nThe Content Customization API provides endpoints for creating, reading, updating, and deleting identity verification (IDV) content customization kits. Content customizations define display text, labels, and styling (colors, fonts, buttons) for the IDV user experience. They can be attached to verification flows via contentCustomizationId.
Base path: {{baseUrl}}/cc/api/idv/content-customization
A content customization kit includes:
\ndisplayName – Name for the kit (e.g. for admin UI)
\ndescription – Optional description
\ncontentMap – Per-screen text: instructions, consent, login identifier, phone/email, OTP, location, verified credential, IDV1, document upload, await, approver screens, etc.
\nstylePaletteMap – Theming: header/logo, body/heading colors and sizes, progress bar, primary/secondary/tertiary button styles, input styles, and related options
\nBranding – Match IDV screens to your organization’s look and feel
\nCopy – Customize instructions, button labels, and error/success messages per screen
\nTheming – Control colors, fonts, and layout via stylePaletteMap
Reuse – Attach one content customization to multiple verification flows via contentCustomizationId
POST {{baseUrl}}/cc/api/idv/content-customization
Creates a new content customization. Request body is BaseContentCustomizationDTO (displayName, description, contentMap, stylePaletteMap). Response is the created ContentCustomizationDTO (includes id). Returns 201 on success.
GET {{baseUrl}}/cc/api/idv/content-customization
Returns an array of all content customization objects. No query parameters.
\nGET {{baseUrl}}/cc/api/idv/content-customization/defaults
Returns the default HYPR content customization (default copy and style). Useful as a template or for reverting to defaults.
\nGET {{baseUrl}}/cc/api/idv/content-customization/defaults/style
Returns the default HYPR stylePaletteMap only. Useful when you want a style template without pulling default copy.
GET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}
Returns a single content customization by ID. Path parameter contentCustomizationId must be a valid numeric ID. Returns 404 if not found.
GET {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/stylesheet
Returns a structured stylesheet representation derived from the kit’s stylePaletteMap (desktop + mobile palettes). Response is application/json.
PATCH {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}
Updates an existing content customization. Request body is BaseContentCustomizationDTO; only provided fields are updated. Returns the updated ContentCustomizationDTO. Returns 404 if the ID is invalid or not found.
PATCH {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/metadata
Updates only displayName / description (no contentMap / stylePaletteMap).
DELETE {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}
Deletes a content customization by ID. Response body is the deleted content customization object. Verification flows that referenced this kit have their contentCustomizationId set to null. Returns 404 if the ID is invalid or not found.
DELETE {{baseUrl}}/cc/api/idv/content-customization
Deletes all content customizations. Returns 204 No Content on success.
\nPUT {{baseUrl}}/cc/api/idv/content-customization/{contentCustomizationId}/duplicate
Duplicates an existing kit and returns the newly-created kit with a new id.
.../{contentCustomizationId}/screens lists screen names available for the kit..../{contentCustomizationId}/screens/{screenName} returns one screen’s content JSON..../{contentCustomizationId}/screens/{screenName} replaces one screen’s content JSON.All endpoints require a Bearer token. Required scope depends on the operation:
\nWrite (POST, PATCH, DELETE): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, or scope: hypr:affirm:writeContentCustomization.
Read (GET list, GET by id, GET defaults, GET stylesheet): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, scope: hypr:affirm:readContentCustomization, or scope: hypr:affirm:writeContentCustomization.
Success responses use Content-Type: application/json.
Errors use Content-Type: application/problem+json (RFC 7807). Typical status codes: 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 500 (Internal Server Error).
Verification Flows API overview – Attach a content customization to a flow via contentCustomizationId.
Individual endpoint docs: Create, Get all, Get defaults, Get by ID, Get stylesheet, Update, Delete (Content Customization API Postman).
\nPOST {{baseUrl}}/cc/api/idv/oidc
Creates a new identity verification OIDC client config.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeOidcClientConfig
Content-Type: application/json
Request body is the create DTO (e.g. CreateIdentityVerificationOIDCClientConfigDto). Required fields: displayName, authorizationUrl, tokenUrl, rpBaseUrl, clientId. Optional: userInfoUrl, logoutUrl, jwksUrl, clientSecret, userNameClaimAttribute, pkceEnabled, additionalScopesOnAuthReq, resource, genericParameters.
{\n \"displayName\": \"string\",\n \"authorizationUrl\": \"string\",\n \"tokenUrl\": \"string\",\n \"userInfoUrl\": \"string\",\n \"logoutUrl\": \"string\",\n \"jwksUrl\": \"string\",\n \"rpBaseUrl\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"userNameClaimAttribute\": \"string\",\n \"pkceEnabled\": true,\n \"additionalScopesOnAuthReq\": \"string\",\n \"resource\": \"string\",\n \"genericParameters\": {}\n}\n\nOn success the response body is the created OIDC client config (includes the generated id). clientSecret is redacted in the response.
Content-Type: application/json
Same structure as Get OIDC client config; includes id and all configured fields. clientSecret is a redacted placeholder.
DELETE {{baseUrl}}/cc/api/idv/oidc/{id}
Deletes an OIDC client config by ID. The response body is the deleted OIDC client config object. Client secret is redacted in the response.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeOidcClientConfig
The response body is the deleted OIDC client config object (same structure as returned by GET by ID). clientSecret is redacted.
Content-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"authorizationUrl\": \"string\",\n \"tokenUrl\": \"string\",\n \"userInfoUrl\": \"string\",\n \"logoutUrl\": \"string\",\n \"jwksUrl\": \"string\",\n \"rpBaseUrl\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"userNameClaimAttribute\": \"string\",\n \"pkceEnabled\": true,\n \"additionalScopesOnAuthReq\": \"string\",\n \"resource\": \"string\",\n \"genericParameters\": {}\n}\n\nDeletion is permanent. Verification flows that referenced this config via oidcClientConfigId may need to be updated separately.
Use a valid numeric OIDC client config ID. Invalid or non-numeric IDs result in 404 with an RFC 7807 problem detail body.
\nGET {{baseUrl}}/cc/api/idv/oidc/{id}
Returns a single OIDC client config by ID. Client secret is redacted in the response.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readOidcClientConfig
scope: hypr:affirm:writeOidcClientConfig
The response body is a single OIDC client config object.
\nContent-Type: application/json
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"authorizationUrl\": \"string\",\n \"tokenUrl\": \"string\",\n \"userInfoUrl\": \"string\",\n \"logoutUrl\": \"string\",\n \"jwksUrl\": \"string\",\n \"rpBaseUrl\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"userNameClaimAttribute\": \"string\",\n \"pkceEnabled\": true,\n \"additionalScopesOnAuthReq\": \"string\",\n \"resource\": \"string\",\n \"genericParameters\": {}\n}\n\nid must be a valid numeric ID (e.g. as returned from POST create or GET list).
Invalid or non-numeric IDs result in 404 with an RFC 7807 problem detail body.
\nGET {{baseUrl}}/cc/api/idv/oidc
Returns all OIDC client configs. No query or path parameters. Client secrets are redacted in the response.
\nType: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readOidcClientConfig
scope: hypr:affirm:writeOidcClientConfig
The response body is a JSON array of OIDC client config objects.
\nContent-Type: application/json
[\n {\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"authorizationUrl\": \"string\",\n \"tokenUrl\": \"string\",\n \"userInfoUrl\": \"string\",\n \"logoutUrl\": \"string\",\n \"jwksUrl\": \"string\",\n \"rpBaseUrl\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"userNameClaimAttribute\": \"string\",\n \"pkceEnabled\": true,\n \"additionalScopesOnAuthReq\": \"string\",\n \"resource\": \"string\",\n \"genericParameters\": {}\n }\n]\n\nPATCH {{baseUrl}}/cc/api/idv/oidc
Updates an existing OIDC client config. Request body must include id; only provided non-blank fields are updated. Omitted or blank fields retain their current values. To leave the client secret unchanged, omit clientSecret or send the redacted placeholder value.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:writeOidcClientConfig
Content-Type: application/json
Request body is the full OIDC client config DTO (IdentityVerificationOIDCClientConfigDto) including id. Send only the fields you want to change; blank or omitted fields keep existing values.
{\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"authorizationUrl\": \"string\",\n \"tokenUrl\": \"string\",\n \"userInfoUrl\": \"string\",\n \"logoutUrl\": \"string\",\n \"jwksUrl\": \"string\",\n \"rpBaseUrl\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"userNameClaimAttribute\": \"string\",\n \"pkceEnabled\": true,\n \"additionalScopesOnAuthReq\": \"string\",\n \"resource\": \"string\",\n \"genericParameters\": {}\n}\n\nThe response body is the updated OIDC client config (full object). clientSecret is redacted.
Content-Type: application/json
Same structure as Get OIDC client config; includes id and all fields. clientSecret is a redacted placeholder.
id in the request body must match an existing OIDC client config (valid numeric ID).
To update the client secret, send the new value in clientSecret. To leave it unchanged, omit clientSecret or send the same redacted placeholder returned by GET.
The Identity Verification OIDC Client Config API provides endpoints for creating, reading, updating, and deleting OIDC (OpenID Connect) client configurations used by identity verification (IDV). These configs define how IDV integrates with an external identity provider (e.g. for requester or approver login). They can be referenced by verification flows via oidcClientConfigId.
Base path: {{baseUrl}}/cc/api/idv/oidc
An OIDC client config includes:
\ndisplayName – Label for the config (e.g. for admin UI)
\nauthorizationUrl – OIDC authorization endpoint URL
\ntokenUrl – OIDC token endpoint URL
\nuserInfoUrl – OIDC userinfo endpoint URL (optional)
\nlogoutUrl – RP-initiated logout URL (optional)
\njwksUrl – JWKS URL for key resolution (optional)
\nrpBaseUrl – Relying party base URL (used to build redirect/callback URLs)
\nclientId – OAuth client ID issued by the authorization server
\nclientSecret – OAuth client secret (stored encrypted; redacted in API responses)
\nuserNameClaimAttribute – OIDC claim to map to username (default: sub)
pkceEnabled – Whether PKCE is enabled
\nadditionalScopesOnAuthReq – Comma-separated scopes for the authorization request (optional)
\nresource – RFC 8707 resource parameter (optional)
\ngenericParameters – Additional parameters for the authorization request (optional)
\nRequester / approver login – Configure OIDC so users sign in with an external IdP before starting or approving a verification.
\nMultiple IdPs – Create several OIDC configs and attach the appropriate one per verification flow.
\nReuse – Reference one OIDC config from multiple verification flows via oidcClientConfigId.
GET {{baseUrl}}/cc/api/idv/oidc
Returns an array of all OIDC client config objects. Secret values are redacted in responses.
\nPOST {{baseUrl}}/cc/api/idv/oidc
Creates a new OIDC client config. Request body is the create DTO (e.g. displayName, authorizationUrl, tokenUrl, userInfoUrl, clientId, clientSecret, rpBaseUrl, etc.). Response is the created config (includes id). Returns 200 on success.
GET {{baseUrl}}/cc/api/idv/oidc/{id}
Returns a single OIDC client config by ID. Path parameter id must be a valid numeric ID. Returns 404 if not found. Secret values are redacted.
PATCH {{baseUrl}}/cc/api/idv/oidc
Updates an existing OIDC client config. Request body is the full DTO including id; only provided non-blank fields are updated. Returns the updated config. Returns 404 if the ID is invalid or not found.
DELETE {{baseUrl}}/cc/api/idv/oidc/{id}
Deletes an OIDC client config by ID. Response body is the deleted config. Returns 404 if the ID is invalid or not found.
\nAll endpoints require a Bearer token. Required scope depends on the operation:
\nWrite (POST create, PATCH update, DELETE): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, or scope: hypr:affirm:writeOidcClientConfig.
Read (GET list, GET by id): One of scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID), scope: hypr:affirm:admin, scope: hypr:affirm:readOidcClientConfig, or scope: hypr:affirm:writeOidcClientConfig.
Success responses use Content-Type: application/json. Client secrets are redacted (replaced with a placeholder) in all responses.
Errors use Content-Type: application/problem+json (RFC 7807). Typical status codes: 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 500 (Internal Server Error).
Verification Flows API overview – Attach an OIDC config to a flow via oidcClientConfigId.
Individual endpoint docs: Get all, Create, Get by ID, Update (PATCH), Delete (OIDC Client Config API Postman).
\nGET {{baseUrl}}/cc/api/idv/results/activityLog
Returns a paginated list of identity verification activity log entries. Results are filtered by creation time between startTSUTC and endTSUTC. An optional search term is matched against workflowId, requester, approver, workflowType, and workflowCode.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readAffirmActivityLog
The response body is a JSON object with data (array of activity log entries) and metadata (pagination info).
Content-Type: application/json
{\n \"data\": [\n {\n \"id\": 0,\n \"workflowId\": \"string\",\n \"workflowCode\": \"string\",\n \"requester\": \"string\",\n \"approver\": \"string\",\n \"createdAt\": 0,\n \"updatedAt\": 0,\n \"verificationFlowId\": 0,\n \"workflowType\": \"string\",\n \"decision\": \"string\",\n \"workflowStepResults\": {\n \"phoneOrEmailStep\": {},\n \"locationStep\": {},\n \"verifiedCredentialStep\": {},\n \"idvStep\": {},\n \"photoIdAndLivenessStep\": {},\n \"approverChatAndVideoStep\": {},\n \"attestationStep\": {}\n }\n }\n ],\n \"metadata\": {\n \"totalRecords\": 0,\n \"totalPages\": 0,\n \"pageSize\": 0,\n \"currentPage\": 0\n }\n}\n\ndata – Array of activity log objects.
\nmetadata – Pagination.
\nstartTSUTC and endTSUTC must be UTC epoch milliseconds. Use a range that covers the verification runs you want (e.g. last 7 days).
When term is provided, only entries matching the term in the searchable fields are returned.
Query parameters match ActivityLogPagedSearchRequest in the codebase (startTSUTC, endTSUTC, optional rpAppsIds, term, pagination, orderBy default createdAt, sortDir default desc).
The IDV Results API provides an endpoint for listing identity verification (IDV) activity log entries. Activity logs record verification workflow runs (e.g. requester, approver, decision, step results) and support paginated search by date range and optional search term.
\nBase path: {{baseUrl}}/cc/api/idv/results
GET {{baseUrl}}/cc/api/idv/results/activityLog
Returns a paginated list of activity log entries. Query parameters: startTSUTC, endTSUTC (required), and optionally term, pageNumber, pageSize, orderBy, sortDir, rpAppsIds. Results are filtered by creation time between the given start and end timestamps (UTC epoch milliseconds). When term is provided, search runs across workflowId, requester, approver, workflowType, and workflowCode.
All endpoints require a Bearer token. Required scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readAffirmActivityLog
Success responses use Content-Type: application/json. The body includes data (array of activity log objects) and metadata (pagination: totalRecords, totalPages, pageSize, currentPage).
Errors use Content-Type: application/problem+json (RFC 7807). Typical status codes: 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 500 (Internal Server Error).
GET {{baseUrl}}/cc/api/idv/helpdesk/workflows/{workflowId}
Returns the full activity log for a single workflow by workflow ID.
\nType: Bearer token
\nhypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)hypr:affirm:adminhypr:affirm:readAffirmActivityLogThe response body is a single activity log object.
\nContent-Type: application/json
{\n \"id\": 0,\n \"workflowId\": \"string\",\n \"workflowCode\": \"string\",\n \"requester\": \"string\",\n \"approver\": \"string\",\n \"createdAt\": 0,\n \"updatedAt\": 0,\n \"verificationFlowId\": 0,\n \"workflowType\": \"string\",\n \"decision\": \"string\",\n \"workflowStepResults\": {\n \"phoneOrEmailStep\": {\n \"smsSendTime\": 0,\n \"otpVerified\": \"string\",\n \"phoneNumberVerified\": \"string\",\n \"emailVerified\": \"string\",\n \"otpMedium\": \"string\"\n },\n \"locationStep\": {\n \"locationAcquired\": \"string\",\n \"ipLocation\": {},\n \"browserLocation\": {},\n \"ipListCheck\": \"string\",\n \"distanceThresholdCheck\": \"string\"\n },\n \"verifiedCredentialStep\": {},\n \"idvStep\": {},\n \"photoIdAndLivenessStep\": {},\n \"approverChatAndVideoStep\": {},\n \"attestationStep\": {}\n }\n}\nworkflowId from GET {{baseUrl}}/cc/api/idv/helpdesk/workflows or from your workflow system. If no activity log exists for that ID, the server returns 404 (ActivityLogNotFoundProblem, RFC 7807).GET {{baseUrl}}/cc/api/idv/helpdesk/workflows
Returns a paginated list of helpdesk workflow activity logs. The time range is server-defined: a rolling window of helpdeskRecordTimeWindowHours ending at the current time (not passed as query parameters; often configured as 24 hours). Optional search term and pagination/sort query parameters are supported.
Type: Bearer token
\nRequired scope (one of):
\nscope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readAffirmActivityLog
The response body is a JSON object with data (array of activity log entries) and metadata (pagination info).
Content-Type: application/json
{\n \"data\": [\n {\n \"id\": 0,\n \"workflowId\": \"string\",\n \"workflowCode\": \"string\",\n \"requester\": \"string\",\n \"approver\": \"string\",\n \"createdAt\": 0,\n \"updatedAt\": 0,\n \"verificationFlowId\": 0,\n \"workflowType\": \"string\",\n \"decision\": \"string\",\n \"workflowStepResults\": {\n \"phoneOrEmailStep\": {},\n \"locationStep\": {},\n \"verifiedCredentialStep\": {},\n \"idvStep\": {},\n \"photoIdAndLivenessStep\": {},\n \"approverChatAndVideoStep\": {},\n \"attestationStep\": {}\n }\n }\n ],\n \"metadata\": {\n \"totalRecords\": 0,\n \"totalPages\": 0,\n \"pageSize\": 0,\n \"currentPage\": 0\n }\n}\n\ndata – Array of activity log objects.
\nmetadata – Pagination.
\nstartTSUTC/endTSUTC query parameters on this endpoint. For an explicit date range, use GET {{baseUrl}}/cc/api/idv/results/activityLog instead.The Affirm Helpdesk Workflows API provides endpoints for listing and retrieving identity verification (IDV) helpdesk workflow activity. Use these to get a paginated list of workflow runs (e.g. for the last 24 hours) or the full activity log for a single workflow by ID.
\nBase path: {{baseUrl}}/cc/api/idv/helpdesk (workflow activity under /workflows)
GET {{baseUrl}}/cc/api/idv/helpdesk/workflows
Returns a paginated list of activity log entries. The time range is not supplied by the client: the server uses a tenant-configured rolling window (helpdeskRecordTimeWindowHours, ending at “now”; often 24 hours). Query parameters: optional term, pageIndex, pageSize, orderBy, sortDir. When term is provided, search runs across workflowId, requester, approver, workflowType, and workflowCode.
GET {{baseUrl}}/cc/api/idv/helpdesk/workflows/{workflowId}
Returns the full activity log for one workflow. Path parameter workflowId is the workflow instance ID. Returns 404 or error if not found (behavior may vary by implementation).
All endpoints require a Bearer token. Required scope (one of), matching AffirmApiAuthorizationExpressions.ACTIVITY_LOG_READ on the API controller:
scope: hypr:cc:applications (with principal = CC_ADMIN_RPAPP_ID)
scope: hypr:affirm:admin
scope: hypr:affirm:readAffirmActivityLog
Success responses use Content-Type: application/json. List returns data (array of activity log objects) and metadata (pagination). Get by ID returns a single activity log object.
Errors use Content-Type: application/problem+json (RFC 7807). Typical status codes: 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 500 (Internal Server Error).
IDV Results API – Alternative activity log listing with explicit date range (/cc/api/idv/results/activityLog).
Individual endpoint docs: List workflows, Get workflow by ID (Affirm Helpdesk Workflows API Postman).
\nPOST {{baseUrl}}/cc/api/bulk/fetch
Bulk extract API used to query supported entities (tables). This document describes one specific request: fetching IDV activity log rows with a filter and pagination.
\nType: Bearer token
\nRequired: scope: hypr:rp:report with principal = CC_ADMIN_RPAPP_ID (Control Center admin RP app).
Content-Type: application/json
Use the following body to fetch IDV activity log rows with the listed fields, filter (id > 0), and pagination.
{\n \"target\": {\n \"subject\": \"idvactivitylog\",\n \"fields\": [\n \"id\",\n \"workflowId\",\n \"requester\",\n \"approver\",\n \"createdAt\",\n \"updatedAt\",\n \"verificationFlowId\",\n \"workflowType\",\n \"decision\",\n \"workflowStepResults\"\n ],\n \"filter\": {\n \"args\": [\n {\n \"filter\": {\n \"op\": \"GT\",\n \"fieldRef\": \"id\",\n \"literal\": \"0\"\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"page\": 0,\n \"rows\": 10\n }\n}\n\nFilter structure: Top-level filter has args, each element is an operand: either filter (single condition: op, fieldRef, literal) or relop (nested AND/OR/NOT with more args). This example uses a single condition: id GT 0.
Other filter ops: LT, EQ, LIKE (for text; use % in literal as needed). Combiners: AND, OR, NOT in a relop.
When the request is valid and pagination is present, the response includes a list of result rows.
\nContent-Type: application/json
{\n \"status\": \"string\",\n \"count\": 0,\n \"cost\": 0,\n \"results\": [\n {\n \"id\": 0,\n \"workflowId\": \"string\",\n \"requester\": \"string\",\n \"approver\": \"string\",\n \"createdAt\": 0,\n \"updatedAt\": 0,\n \"verificationFlowId\": 0,\n \"workflowType\": \"string\",\n \"decision\": \"string\",\n \"workflowStepResults\": {}\n }\n ]\n}\n\nEach item in results has the fields requested in target.fields (e.g. id, workflowId, requester, approver, createdAt, updatedAt, verificationFlowId, workflowType, decision, workflowStepResults). Types follow the entity (e.g. numbers, strings, timestamps, nested object for workflowStepResults).
This doc describes only the request shape above for idvactivitylog. The bulk fetch API supports other entities and request shapes; see bulk introspect endpoints or implementation for the full model.
\nSubject name is idvactivitylog (bulk/entity name), not the table name idv_activity_log.
To get more pages, repeat the same request with pagination.page = 1, 2, … and same pagination.rows.
If pagination is omitted, the API returns a count only (count set, no results).
For a full description of HYPR Affirm's capabilities, see this section in our Product Documentation.
\nHYPR Affirm collects personally identifiable information (PII) for the purpose of identifying and authenticating a person. This information is only kept as long as it is needed (limited by the expiresOn attribute). If expiresOn is in the past, the userPii array returned in responses will omit all PII except the user's email and loginId.
\n","_postman_id":"f61a3fab-a600-4193-8104-f9d41bd0ce7b","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Email","item":[{"name":"Templates","item":[{"name":"Create Email Template","id":"44a62dcd-0d57-4eca-a157-323cc6af7192","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"templateName\": \"Custom CC User Invite Template\",\n \"templateDescription\": \"template description\",\n \"notificationType\": \"CONTROL_CENTER_USER_INVITE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations","description":"Added in HYPR version 11.1
\nCreate a new email template.
\n201 Created
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n{\n \"templateName\": \"<string>\",\n \"templateDescription\": \"<string>\",\n \"notificationType\": \"<string>\"\n}\n\ntemplateName
\nThe name of the template.
\ntemplateDescription
\nA description of the template.
\nnotificationType
\nThe type of notification this template will be used for. The Control Center sends different types of notifications depending on the action being performed on the app. Below are the notification types available and a description of their usage:
\nGeneral Notifications
\nCONTROL_CENTER_USER_INVITE - An invite sent to a user to register an account for the HYPR Control Center.
\nCONTROL_CENTER_USER_RECOVERY - Sent to the owner of a registered account in the HYPR Control Center in order to recover lost access.
\nHYPR Affirm Notifications
\nAFFIRM_APPROVER_INVITE - An invite sent to a user to join an Affirm workflow as an approver.
AFFIRM_HELPDESK_USER_INVITE - An invite sent to a user to register an account for the Affirm Helpdesk application.
AFFIRM_HELPDESK_USER_RECOVERY - Sent to the owner of a registered account in the Affirm Helpdesk application in order to recover lost access.
AFFIRM_OTP - Provides an OTP to a requester to verify their email address.
AFFIRM_WORKFLOW_INVITE - An invite sent to a user to complete a new Affirm workflow.
\nIntegration Notifications
\nAUTH_INTEGRATION_USER_INVITE - An invite sent to a user to register a device for a non-SSO HYPR Integration (e.g. Radius).
\nAUTH_INTEGRATION_USER_RECOVERY - Sent to the owner of a registered account in a non-SSO HYPR Integration in order to recover lost access.
\nENTRA_NATIVE_INTEGRATION_USER_INVITE - An invite sent to a user to register a device for an Entra Native HYPR Integration.
\nINTEGRATION_USER_INVITE - An invite sent to a user to register a device for an SSO HYPR Integration.
\nINTEGRATION_USER_RECOVERY - Sent to the owner of a registered account in an SSO or Entra Native HYPR Integration in order to recover lost access.
\nDevice Manager Notifications
\n{\n \"id\": \"<string>\",\n \"templateName\": \"<string>\",\n \"templateDescription\": \"<string>\",\n \"notificationType\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <integer>,\n \"updatedAt\": <integer>,\n \"versions\": [\n {\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <integer>,\n \"updatedAt\": <integer>\n }\n ]\n\nid
\nThe ID of the new template.
\ntemplateName
\nThe name of the template.
\ntemplateDescription
\nA description of the template.
\nnotificationType
\nThe type of notification this template will be used for.
\ncreatedBy
\nWho created the template.
\ncreatedAt
\nUnix timestamp of when the template was created.
\nupdatedAt
\nUnix timestamp of when the template was last updated.
\nversions
\nThe list of versions of this template. Each version object will have the following parameters:
\nversionId - The ID of this version
\nversionName - The name of this version
\ncustomizationType [SIMPLE | ADVANCED] - The type of customization allowed for this version
\ncreatedBy - Who created the version.
\ncreatedAt - Unix timestamp of when the version was created.
\nupdatedAt - Unix timestamp of when the version was last updated.
\nAdded in HYPR version 11.1
\nGet all email templates.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n[\n {\n \"id\": \"<string>\",\n \"templateName\": \"<string>\",\n \"templateDescription\": \"<string>\",\n \"notificationType\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <integer>,\n \"updatedAt\": <integer>,\n \"versions\": [\n {\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <integer>,\n \"updatedAt\": <integer>\n }\n ]\n },\n {\n ...\n }\n]\n\nEach template will have the following parameters:
\nid
\nThe ID of the template.
\ntemplateName
\nThe name of the template.
\ntemplateDescription
\nA description of the template.
\nnotificationType
\nThe type of notification this template will be used for.
\ncreatedBy
\nWho created the template.
\ncreatedAt
\nUnix timestamp of when the template was created.
\nupdatedAt
\nUnix timestamp of when the template was last updated.
\nversions
\nThe list of versions of this template. Each version object will have the following parameters:
\nversionId - The ID of this version
\nversionName - The name of this version
\ncustomizationType [SIMPLE | ADVANCED] - The type of customization allowed for this version
\ncreatedBy - Who created the version.
\ncreatedAt - Unix timestamp of when the version was created.
\nupdatedAt - Unix timestamp of when the version was last updated.
\nAdded in HYPR version 11.1
\nUpdate an email template.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n{\n \"id\": \"<string>\",\n \"templateName\": \"<string>\",\n \"templateDescription\": \"<string>\"\n}\n\nid
\nThe ID of the template being updated.
\ntemplateName
\nThe name of the template.
\ntemplateDescription
\nA description of the template.
\n{\n \"id\": \"<string>\",\n \"templateName\": \"<string>\",\n \"templateDescription\": \"<string>\",\n \"notificationType\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <integer>,\n \"updatedAt\": <integer>,\n \"versions\": [\n {\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <integer>,\n \"updatedAt\": <integer>\n }\n ]\n} \n\nid
\nThe ID of the template.
\ntemplateName
\nThe name of the template.
\ntemplateDescription
\nA description of the template.
\nnotificationType
\nThe type of notification this template will be used for.
\ncreatedBy
\nWho created the template.
\ncreatedAt
\nUnix timestamp of when the template was created.
\nupdatedAt
\nUnix timestamp of when the template was last updated.
\nversions
\nThe list of versions of this template. Each version object will have the following parameters:
\nversionId - The ID of this version
\nversionName - The name of this version
\ncustomizationType [SIMPLE | ADVANCED] - The type of customization allowed for this version
\ncreatedBy - Who created the version.
\ncreatedAt - Unix timestamp of when the version was created.
\nupdatedAt - Unix timestamp of when the version was last updated.
\nAdded in HYPR version 11.1
\nDelete an email template.
\n204 No Content
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\ntemplateId
\nThe ID of the template being deleted.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations",":templateId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"442bcae4-69d9-4420-b4ab-2334b93b4109","type":"any","value":"","key":"templateId"}]}},"response":[{"id":"fc02c90c-0c0d-4510-8690-fb9d3aa2feff","name":"204 No Content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId"],"variable":[{"key":"templateId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2855ad66-c6f5-4899-ad67-25fe198c8682"},{"name":"Create Email Template Version","id":"0d8c6a3c-e8ae-4cbd-af3e-1c045dfebeb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"versionName\": \"Version 1.0\",\n \"customizationType\": \"SIMPLE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/:templateId/version","description":"Added in HYPR version 11.1
\nCreate a new version for an email template.
\n201 Created
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\ntemplateId
\nThe ID of the parent template.
\n{\n \"versionName\": \"<string>\",\n \"customizationType\": \"<string>\"\n}\n\nversionName
\nThe name of the version.
\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customizations allowed for this version.
\nSIMPLE - Customizations are handled through modules. These modules will accept specific inputs that will then be injected into a static layout that renders the email.
\nADVANCED - Customizations are handled by a user providing the HTML content that will be used to render the email.
\n{\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": <integer>,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\",\n \"htmlSizeKB\": <integer>,\n \"createdBy\": \"<string>\",\n \"createdAt\": <long>,\n \"updatedAt\": <long>\n}\n\nversionId
\nThe ID of the version.
\nversionName
\nThe name of the version.
\ncustomizationId
\nThe ID of the parent template.
\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customizations allowed for this version.
\nglobalContent
\nOnly usable for SIMPLE customization types
\nAn object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle
\nOnly usable for SIMPLE customization types
\nAn object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules
\nOnly usable for SIMPLE customization types
\nModules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE]
\nIf TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent
\nOnly usable for ADVANCED customization types
\nThe HTML content of the email template
\ntextContent
\nThe plaintext version of the email. If autoGenerateTextContent is TRUE, this will automatically update whenever the template is updated. Any manual changes will be discarded.
\nhtmlSizeKB
\nThe size (in kilobytes) of the rendered version of the HTML template content.
\ncreatedBy
\nWho created the template version.
\ncreatedAt
\nUnix timestamp of when the template version was created.
\nupdatedAt
\nUnix timestamp of when the template version was last updated.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations",":templateId","version"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e71c88ec-4e12-4a0a-a1b7-72bcd5b5e104","type":"any","value":"","key":"templateId"}]}},"response":[{"id":"355cbf64-fdf1-4f27-9b10-ba2eeb50c7d1","name":"201 Created (Simple)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"versionName\": \"Version 1.0\",\n \"customizationType\": \"SIMPLE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId/version","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId","version"],"variable":[{"key":"templateId","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"},{"id":"48add8b2-cea1-4c20-aec6-14f48820a919","name":"201 Created (Advanced)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"versionName\": \"Version 1.0\",\n \"customizationType\": \"ADVANCED\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId/version","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId","version"],"variable":[{"key":"templateId","value":""}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"ADVANCED\",\n \"globalContent\": null,\n \"globalStyle\": null,\n \"modules\": [],\n \"autoGenerateTextContent\": false,\n \"htmlContent\": \"Have Questions?
Read the GuideDownload the HYPR app now\",\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"}],"_postman_id":"0d8c6a3c-e8ae-4cbd-af3e-1c045dfebeb8"},{"name":"Get Email Template Version","id":"9c56b8e5-f708-40b8-bb75-a42f332fc4b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId","description":"Added in HYPR version 11.1
\nGet an email template version
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\ntemplateId
\nThe ID of the parent template.
\nversionId
\nThe ID of the version.
\n{\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": 4,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\",\n \"htmlSizeKB\": <integer>,\n \"createdBy\": \"<string>\",\n \"createdAt\": <long>,\n \"updatedAt\": <long>\n}\n\nversionId
\nThe ID of the version.
\nversionName
\nThe name of the version.
\ncustomizationId
\nThe ID of the parent template.
\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customizations allowed for this version.
\nglobalContent
\nOnly usable for SIMPLE customization types
\nAn object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle
\nOnly usable for SIMPLE customization types
\nAn object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules
\nOnly usable for SIMPLE customization types
\nModules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE]
\nIf TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent
\nOnly usable for ADVANCED customization types
\nThe HTML content of the email template
\ntextContent
\nThe plaintext version of the email. If autoGenerateTextContent is TRUE, this will automatically update whenever the template is updated. Any manual changes will be discarded.
\nhtmlSizeKB
\nThe size (in kilobytes) of the rendered version of the HTML template content.
\ncreatedBy
\nWho created the template version.
\ncreatedAt
\nUnix timestamp of when the template version was created.
\nupdatedAt
\nUnix timestamp of when the template version was last updated.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations",":templateId","version",":versionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"2d804ff4-8663-478a-ab70-ac305de53fbf","type":"any","value":"","key":"templateId"},{"id":"456dc0f1-5afc-470d-ba35-c16fe906750a","type":"any","value":"","key":"versionId"}]}},"response":[{"id":"5349dcc8-a6ca-4c55-838d-6f3496369a27","name":"200 OK (Simple)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId","version",":versionId"],"variable":[{"key":"templateId","value":""},{"key":"versionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"},{"id":"388f75cc-686b-4539-b27e-fdbb4eae0c65","name":"200 OK (Advanced)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId","version",":versionId"],"variable":[{"key":"templateId","value":""},{"key":"versionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"ADVANCED\",\n \"globalContent\": null,\n \"globalStyle\": null,\n \"modules\": [],\n \"autoGenerateTextContent\": false,\n \"htmlContent\": \"Have Questions?
Read the GuideDownload the HYPR app now\",\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"}],"_postman_id":"9c56b8e5-f708-40b8-bb75-a42f332fc4b7"},{"name":"Update Email Template Version","id":"2ab4c1e1-dcfc-4ad2-953e-ff573fb6257e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"versionId\": \"479bcb49\",\n \"versionName\": \"Main Version\",\n \"customizationId\": \"608553537993572352\",\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation | HYPR\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr59675.dev.hypr.com/static/images/emails/hypr-logo-white.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Hi {{attr::firstName}}, your colleague has invited you to register for an account on the HYPR Control Center.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"LEFT\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 400,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 20,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 16,\n \"buttonPaddingLeft\": 64,\n \"buttonPaddingRight\": 64,\n \"buttonPaddingBottom\": 16,\n \"textDecoration\": \"underline\",\n \"borderRadius\": 4,\n \"text\": \"Click Here to Join Now\",\n \"url\": \"{{attr::inviteLink}}\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Please note that this link expires after 7 days.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 0,\n \"width\": 400,\n \"content\": \"Some helpful info
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 0,\n \"width\": 400,\n \"content\": \"Username: {{attr::username}}
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 400,\n \"content\": \"Control Center URL: {{global::controlCenterUrl}}
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Need help? Send an email to {{global::supportEmail}}
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 0,\n \"width\": 400,\n \"columns\": [\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR Control Center.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"{{global::docsUrl}}\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Get the App
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"On mobile? Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr59675.dev.hypr.com/static/images/emails/ios-app-store-badge.png\",\n \"link\": \"https://apps.apple.com/us/app/hypr/id1343368858\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"Android app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr59675.dev.hypr.com/static/images/emails/android-app-store-badge.png\",\n \"link\": \"https://play.google.com/store/apps/details?id=com.hypr.one&hl=en_IN\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to the HYPR Control Center\\n\\nHi {{attr::firstName}}, your colleague has invited you to register for an account on the HYPR Control Center.\\n\\nClick Here to Join Now ({{attr::inviteLink}})\\n\\nPlease note that this link expires after 7 days.\\n\\nSome helpful info\\n\\nUsername: {{attr::username}}\\n\\nControl Center URL: {{global::controlCenterUrl}} ({{global::controlCenterUrl}})\\n\\nNeed help? Send an email to {{global::supportEmail}} (mailto:{{global::supportEmail}})\\n\\nHave Questions?\\n\\nClick below to learn more about the HYPR Control Center.\\n\\nRead the Guide ({{global::docsUrl}})\\n\\nGet the App\\n\\nOn mobile? Download the HYPR app now.\\n\\nIOS app (https://apps.apple.com/us/app/hypr/id1343368858)\\n\\nAndroid app (https://play.google.com/store/apps/details?id=com.hypr.one&hl=en_IN)\\n\\n\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"joe.oravbiere@hypr.com\",\n \"createdAt\": 1769118205000,\n \"updatedAt\": 1769118205000\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/version","description":"Added in HYPR version 11.1
\nUpdate an email template version.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n{\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": <integer>,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\"\n}\n\nversionId
\nThe ID of the version being updated.
\nversionName
\nThe name of the version.
\ncustomizationId
\nThe ID of the parent template.
\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customizations allowed for this version. If this is modified in an existing version, the content of the email may change based on the modification being made.
\nglobalContent
\nOnly usable for SIMPLE customization types
\nAn object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle
\nOnly usable for SIMPLE customization types
\nAn object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules
\nOnly usable for SIMPLE customization types
\nModules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE]
\nIf TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent
\nOnly usable for ADVANCED customization types
\nThe HTML content of the email template
\ntextContent
\nThe plaintext version of the email. If autoGenerateTextContent is TRUE, this will automatically update whenever the template is updated. Any manual changes will be discarded.
\n{\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": <integer>,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\",\n \"htmlSizeKB\": <integer>,\n \"createdBy\": \"<string>\",\n \"createdAt\": <long>,\n \"updatedAt\": <long>\n}\n\nversionId
\nThe ID of the version.
\nversionName
\nThe name of the version.
\ncustomizationId
\nThe ID of the parent template.
\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customizations allowed for this version.
\nglobalContent
\nOnly usable for SIMPLE customization types
\nAn object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle
\nOnly usable for SIMPLE customization types
\nAn object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules
\nOnly usable for SIMPLE customization types
\nModules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE]
\nIf TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent
\nOnly usable for ADVANCED customization types
\nThe HTML content of the email template
\ntextContent
\nThe plaintext version of the email. If autoGenerateTextContent is TRUE, this will automatically update whenever the template is updated. Any manual changes will be discarded.
\nhtmlSizeKB
\nThe size (in kilobytes) of the rendered version of the HTML template content.
\ncreatedBy
\nWho created the template version.
\ncreatedAt
\nUnix timestamp of when the template version was created.
\nupdatedAt
\nUnix timestamp of when the template version was last updated.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations","version"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f61b67bb-f7cb-4a08-94db-968df119595e","name":"200 OK (Simple)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/version"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"},{"id":"31d93b12-c777-4814-8f00-7f653d6a014e","name":"200 OK (Advanced)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"ADVANCED\",\n \"globalContent\": null,\n \"globalStyle\": null,\n \"modules\": [],\n \"autoGenerateTextContent\": false,\n \"htmlContent\": \"Have Questions?
Read the GuideDownload the HYPR app now\",\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/version"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"ADVANCED\",\n \"globalContent\": null,\n \"globalStyle\": null,\n \"modules\": [],\n \"autoGenerateTextContent\": false,\n \"htmlContent\": \"Have Questions?
Read the GuideDownload the HYPR app now\",\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"}],"_postman_id":"2ab4c1e1-dcfc-4ad2-953e-ff573fb6257e"},{"name":"Delete Email Template Version","id":"cad4665d-caa4-4acf-9eb3-06a4d5482c1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId","description":"Added in HYPR version 11.1
\nDelete an email template verson.
\n204 No Content
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\ntemplateId
\nThe ID of the parent template.
\nversionId
\nThe ID of the version being deleted.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations",":templateId","version",":versionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"0b6d24cc-ba0c-493d-aae1-d58cb1872923","type":"any","value":"","key":"templateId"},{"id":"9a993201-db59-4748-8f9b-cc3ecfc71a52","type":"any","value":"","key":"versionId"}]}},"response":[{"id":"b88d379b-1993-4115-b294-fc21f213b324","name":"204 No Content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId","version",":versionId"],"variable":[{"key":"templateId","value":""},{"key":"versionId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cad4665d-caa4-4acf-9eb3-06a4d5482c1e"},{"name":"Clone Email Template Version","id":"e8655ec8-7c15-4312-a93e-66d61c0f1431","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId/clone","description":"Added in HYPR version 11.1
\nClone a template version.
\n201 Created
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\ntemplateId
\nThe ID of the parent template.
\nversionId
\nThe ID of the version being cloned.
\n{\n \"versionId\": \"<string>\",\n \"versionName\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": <integer>,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\",\n \"htmlSizeKB\": <integer>,\n \"createdBy\": \"<string>\",\n \"createdAt\": <long>,\n \"updatedAt\": <long>\n}\n\nversionId
\nThe ID of the version.
\nversionName
\nThe name of the version.
\ncustomizationId
\nThe ID of the parent template.
\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customizations allowed for this version.
\nglobalContent
\nOnly usable for SIMPLE customization types
\nAn object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle
\nOnly usable for SIMPLE customization types
\nAn object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules
\nOnly usable for SIMPLE customization types
\nModules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE]
\nIf TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent
\nOnly usable for ADVANCED customization types
\nThe HTML content of the email template
\ntextContent
\nThe plaintext version of the email. If autoGenerateTextContent is TRUE, this will automatically update whenever the template is updated. Any manual changes will be discarded.
\nhtmlSizeKB
\nThe size (in kilobytes) of the rendered version of the HTML template content.
\ncreatedBy
\nWho created the template version.
\ncreatedAt
\nUnix timestamp of when the template version was created.
\nupdatedAt
\nUnix timestamp of when the template version was last updated.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations",":templateId","version",":versionId","clone"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"412952a0-7821-4cee-ae61-97b133d412d5","type":"any","value":"","key":"templateId"},{"id":"4728902b-df3d-4b6c-9781-250641b495e9","type":"any","value":"","key":"versionId"}]}},"response":[{"id":"53f4e63d-3893-476e-a6ee-c77c75211cf5","name":"201 Created","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/cc/api/email/customizations/:templateId/version/:versionId/clone","host":["{{baseUrl}}"],"path":["cc","api","email","customizations",":templateId","version",":versionId","clone"],"variable":[{"key":"templateId","value":""},{"key":"versionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"versionId\": \"bb132fbb\",\n \"versionName\": \"Version 1.0 (Clone)\",\n \"customizationId\": \"612529078763769856\",\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now (https://hypr.com/invite/abc123def456)\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18,\n \"createdBy\": \"john.doe@hypr.com\",\n \"createdAt\": 1770146251751,\n \"updatedAt\": 1770146251751\n}"}],"_postman_id":"e8655ec8-7c15-4312-a93e-66d61c0f1431"},{"name":"Preview Email","id":"c9ec3279-1285-49b6-a2e1-0da434cbacf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now ({{attr:inviteLink}})\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"injectAttributes\": true,\n \"templateAttributes\": {\n \"inviteLink\": \"https://example.com/invite/123abc456def\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/preview","description":"Added in HYPR version 11.1
\nGenerate the rendered HTML content for an email template for previewing.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n{\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": 4,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\",\n \"injectAttributes\": <boolean>,\n \"templateAttributes\": <map>\n}\n\ncustomizationType [SIMPLE | ADVANCED]
\nThe type of customization
\nglobalContent
\nOnly usable for SIMPLE customization types
\nAn object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle
\nOnly usable for SIMPLE customization types
\nAn object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules
\nOnly usable for SIMPLE customization types
\nModules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE]
\nIf TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent
\nOnly usable for ADVANCED customization types
\nThe HTML content of the email template
\ntextContent
\nThe plaintext version of the email. If autoGenerateTextContent is TRUE, this value will be ignored.
\ntemplateAttributes
\nA map of values that will be used to replace attribute placeholders in the template.
\ninjectAttributes [TRUE | FALSE]
\nIf TRUE, all attributes in the template will be replaced with the values defined in templateAttributes. If FALSE, all attribute placeholders will remain as is.
\n{\n \"renderedHtml\": \"<string>\",\n \"renderedText\": \"<string>\",\n \"htmlSizeKB\": <integer>\n}\n\nrenderedHtml
\nA string containing the generated HTML from the template payload.
\nrenderedText
\nA string containing the generated plaintext from the template payload.
\nhtmlSizeKB
\nThe size (in kilobytes) of the rendered HTML.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","customizations","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"1158c1ee-d800-4331-91e6-87502235b2ca","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now ({{attr:inviteLink}})\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"injectAttributes\": true,\n \"templateAttributes\": {\n \"inviteLink\": \"https://example.com/invite/123abc456def\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/preview"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"renderedHtml\": \"Have Questions?
Read the GuideDownload the HYPR app now\",\n \"renderedText\": \"Welcome to HYPR\\nClick Here to Join Now \\\"https://example.com/invite/123abc456def\\\"\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"htmlSizeKB\": 18\n}"}],"_postman_id":"c9ec3279-1285-49b6-a2e1-0da434cbacf9"},{"name":"Test Email","id":"72a3640a-aeac-497f-bfeb-c754389ed116","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"recipientAddresses\": [\"john.doe@hypr.com\"],\n \"templateDetails\": {\n \"customizationType\": \"SIMPLE\",\n \"globalContent\": {\n \"subject\": \"Your HYPR Invitation\"\n },\n \"globalStyle\": {\n \"contentWidth\": 600,\n \"textColor\": \"#000000\",\n \"linkColor\": \"#0000EE\",\n \"outerBackgroundType\": \"GRADIENT\",\n \"outerBackgroundColor\": {\n \"color1\": \"#1A1288\",\n \"color2\": \"#881EA0\",\n \"direction\": \"TOP_BOTTOM\"\n },\n \"outerPaddingTop\": 30,\n \"outerPaddingLeft\": 0,\n \"outerPaddingRight\": 0,\n \"outerPaddingBottom\": 30,\n \"innerBackgroundType\": \"SINGLE\",\n \"innerBackgroundColor\": {\n \"color1\": \"#FFFFFF\",\n \"color2\": null,\n \"direction\": null\n },\n \"innerPaddingTop\": 30,\n \"innerPaddingLeft\": 16,\n \"innerPaddingRight\": 16,\n \"innerPaddingBottom\": 32,\n \"innerBorderRadius\": 12\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"HEADER\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 15,\n \"width\": 0,\n \"alt\": \"logo\",\n \"imageWidth\": 200,\n \"assetUrl\": \"https://hypr.com/static/images/logo.png\",\n \"link\": \"\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"BODY\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 400,\n \"content\": \"Have Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now ({{attr:inviteLink}})\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"injectAttributes\": true,\n \"templateAttributes\": {\n \"inviteLink\": \"https://example.com/invite/123abc456def\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/test","description":"Added in HYPR version 11.1
\nGenerates and sends a test email using the provided template payload.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n{\n \"recipientAddresses\": [\"<string>\"],\n \"templateDetails\": {\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": 4,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\",\n \"injectAttributes\": <boolean>,\n \"templateAttributes\": <map>\n }\n}\n\nrecipientAddresses
\nA list of email addresses to send the test email to.
\ntemplateDetails
\nThe template configuration to use to generate the email content. It contains the following parameters:
\ncustomizationType [SIMPLE | ADVANCED] - The type of customization
\nglobalContent (Only usable for SIMPLE customization types) - An object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle (Only usable for SIMPLE customization types) - An object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules (Only usable for SIMPLE customization types) - Modules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE] - If TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent (Only usable for ADVANCED customization types) - The HTML content of the email template.
\ntextContent - The plaintext version of the email. If autoGenerateTextContent is TRUE, this value will be ignored.
\ntemplateAttributes - A map of values that will be used to replace attribute placeholders in the template.
\ninjectAttributes [TRUE | FALSE] - If TRUE, all attributes in the template will be replaced with the values defined in templateAttributes. If FALSE, all attribute placeholders will remain as is.
\nHave Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now ({{attr:inviteLink}})\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\",\n \"injectAttributes\": true,\n \"templateAttributes\": {\n \"inviteLink\": \"https://example.com/invite/123abc456def\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/email/customizations/test"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"72a3640a-aeac-497f-bfeb-c754389ed116"}],"id":"0184a6b0-90af-4f4c-88dc-df0cab00b74e","_postman_id":"0184a6b0-90af-4f4c-88dc-df0cab00b74e","description":"","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Revisions","item":[{"name":"Get Email Template Version Revisions","id":"4911202f-53a7-48fa-b10e-3496243350e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/email/customization/:templateId/version/:versionId/revisions?pageNumber=1&pageSize=20&orderBy=createdAt&sortDir=desc","description":"Added in HYPR version 11.1
\nGet the revisions for a single template version through a search request.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\ntemplateId
\nThe ID of the parent template.
\nversionId
\nThe ID of the version.
\npageNumber
\nThe page number to fetch.
\npageSize
\nThe number of items to retrieve per page.
\norderBy
\nThe payload key to sort by.
\nsortDir [asc | desc]
\nThe sort order direction.
\n{\n \"data\": {\n \"customizationId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"revisions\": [\n {\n \"id\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": <long>\n }\n ]\n },\n \"metadata\": {\n \"totalRecords\": <integer>,\n \"totalPages\": <integer>,\n \"pageSize\": <integer>,\n \"currentPage\": <integer>\n }\n}\n\ndata
\nThe result of the search request. It contains the following parameters:
\ncustomizationId - The ID of the parent template.
\nversionId - The ID of the version.
\nrevisions - The list of revisions found in the request. It contains the following parameters:
\nid - The ID of the revision.
\ncreatedBy - Who made this revision.
\ncreatedAt - When this revision was made.
\nmetadata
\nDetails about the search request. It contains the following parameters:
\ntotalRecords - The total number of revisions found.
\ntotalPages - The total number of pages of records available based on the page size.
\npageSize - The number of records found on this paged request.
\ncurrentPage - The current page returned from this request.
\nAdded in HYPR version 11.1
\nGet the snapshot of a template from a specific revision.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\nrevisionId
\nThe ID of the revision.
\n{\n \"id\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"versionId\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"customizationVersion\": {\n \"customizationType\": \"<string>\",\n \"globalContent\": {\n \"subject\": \"<string>\"\n },\n \"globalStyle\": {\n \"contentWidth\": <integer>,\n \"textColor\": \"<string>\",\n \"linkColor\": \"<string>\",\n \"outerBackgroundType\": \"<string>\",\n \"outerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"outerPaddingTop\": <integer>,\n \"outerPaddingLeft\": <integer>,\n \"outerPaddingRight\": <integer>,\n \"outerPaddingBottom\": <integer>,\n \"innerBackgroundType\": \"<string>\",\n \"innerBackgroundColor\": {\n \"color1\": \"<string>\",\n \"color2\": \"<string>\",\n \"direction\": \"<string>\"\n },\n \"innerPaddingTop\": <integer>,\n \"innerPaddingLeft\": <integer>,\n \"innerPaddingRight\": <integer>,\n \"innerPaddingBottom\": <integer>,\n \"innerBorderRadius\": <integer>\n },\n \"modules\": [\n {\n \"type\": \"IMAGE\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"alt\": \"<string>\",\n \"imageWidth\": <integer>,\n \"assetUrl\": \"<string>\",\n \"link\": \"<string>\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"content\": \"<string>\",\n \"color\": \"<string>\",\n \"textAlign\": \"<string>\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"backgroundColor\": \"<string>\",\n \"textColor\": \"<string>\",\n \"fontSize\": <integer>,\n \"fontWeight\": <integer>,\n \"buttonPaddingTop\": <integer>,\n \"buttonPaddingLeft\": <integer>,\n \"buttonPaddingRight\": <integer>,\n \"buttonPaddingBottom\": <integer>,\n \"textDecoration\": \"<string>\",\n \"borderRadius\": <integer>,\n \"text\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"COLUMN\",\n \"placement\": \"<string>\",\n \"paddingTop\": <integer>,\n \"paddingLeft\": <integer>,\n \"paddingRight\": <integer>,\n \"paddingBottom\": <integer>,\n \"width\": <integer>,\n \"columns\": [\n {\n \"modules\": [...]\n }\n ],\n \"columnPadding\": <integer>,\n \"layout\": \"<string>\"\n }\n ],\n \"autoGenerateTextContent\": <boolean>,\n \"htmlContent\": \"<string>\",\n \"textContent\": \"<string>\"\n }\n}\n\nid
\nThe ID of the revision.
\ncustomizationId
\nThe ID of the parent template.
\nversionId
\nThe ID of the template version.
\ncreatedBy
\nWho created the revision.
\ncustomizationVersion
\nThe snapshot of the template version at this revision. It contains the following parameters:
\ncustomizationType [SIMPLE | ADVANCED] - The type of customization
\nglobalContent (Only usable for SIMPLE customization types) - An object containing custom content set outside the main email body. It contains the following parameters:
\nglobalStyle (Only usable for SIMPLE customization types) - An object containing custom styles applied globally to all modules or to the email layout. It contains the following parameters:
\ncontentWidth - The width of the inner container of the email body
\ntextColor - The color of text in the email
\nlinkColor - The color of links in the email
\nouterBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the outer container of the email.
\nSINGLE - The background of the outer container of the email will be a single color set from outerBackgroundColor.
\nGRADIENT - The background of the outer container of the email will be a gradient set from outerBackgroundColor.
\nouterBackgroundColor - An object containing the color configuration of the outer container background. It contains the following parameters:
\ncolor1 - A CSS color value. If outerBackgroundType is set to SINGLE, this will be the background color of the outer container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If outerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If outerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If outerBackgroundType is set to SINGLE, this value is ignored.
\nouterPaddingTop - The amount of spacing between the top of the outer container and the top of the inner container or topmost header module.
\nouterPaddingLeft - The amount of spacing between the left of the outer container and the left of the inner container.
\nouterPaddingRight - The amount of spacing between the right of the outer container and the right of the inner container.
\nouterPaddingBottom - The amount of spacing between the bottom of the outer container and the bottom of the inner container.
\ninnerBackgroundType [SINGLE | GRADIENT] - Sets the type of background used in the inner container of the email.
\nSINGLE - The background of the inner container of the email will be a single color set from innerBackgroundColor.
\nGRADIENT - The background of the inner container of the email will be a gradient set from innerBackgroundColor.
\ninnerBackgroundColor - An object containing the color configuration of the inner container background. It contains the following parameters:
\ncolor1 - A CSS color value. If innerBackgroundType is set to SINGLE, this will be the background color of the inner container. If set to GRADIENT, this will be the topmost color if direction is set to TOP_BOTTOM or the leftmost color if direction is set to LEFT_RIGHT.
\ncolor2 - A CSS color value. If innerBackgroundType is set to SINGLE, this value will be ignored. If set to GRADIENT, this will be the bottommost color if direction is set to TOP_BOTTOM or the rightmost color if direction is set to LEFT_RIGHT.
\ndirection [TOP_BOTTOM | LEFT_RIGHT] - If innerBackgroundType is set to GRADIENT, this will be the direction of the gradient. If innerBackgroundType is set to SINGLE, this value is ignored.
\ninnerPaddingTop - The amount of spacing between the top of the inner container and the topmost body module.
\ninnerPaddingLeft - The amount of spacing between the left of the inner container and the left of email body.
\ninnerPaddingRight - The amount of spacing between the right of the inner container and the right of the email body.
\ninnerPaddingBottom - The amount of spacing between the bottom of the inner container and the bottommost body module.
\ninnerBorderRadius - The roundness of the corners of the inner container.
\nmodules (Only usable for SIMPLE customization types) - Modules are used to manage the actual content of an email for SIMPLE customization types. Modules contain the following parameters:
\ntype [IMAGE | TEXT | BUTTON | COLUMN] - The type of module. The module type will determine the content and options available to configure in the module.
\nIMAGE - Used to display an image.
\nTEXT - Used to display text.
\nBUTTON - Used to display button-shaped links.
\nCOLUMN - A layout module that enables a user to display modules in a column like structure
\nplacement [HEADER | BODY | COLUMN] - Where the module will be placed in the module.
\nHEADER - Module will be placed at the top of the email, outside the inner container.
\nBODY - Module will be placed inside the inner container.
\nCOLUMN - Module is nested inside a COLUMN type module.
\npaddingTop - The top spacing of the module container.
\npaddingLeft - The left spacing of the module container.
\npaddingRight - The right spacing of the module container.
\npaddingBottom - The bottom spacing of the module container.
\nwidth - The width of the module container.
\nThe following parameters are available for specific module types:
\nIMAGE
\nalt - The alt text for the image
\nimageWidth - The width of the image.
\nassetUrl - The URL of the image.
\nlink - An anchor link for the image. Enables a user to add links to an email through images.
\nTEXT
\ncontent - The actual text content. Has some minimal HTML support.
\ncolor - The color of the text.
\ntextAlign [LEFT | CENTER | RIGHT] - The alignment of the text
\nBUTTON
\nbackgroundColor -The background color of the button.
\ntextColor - The text color of the button.
\nfontSize - The font size of the button text.
\nfontWeight - The font weight of the button text.
\nbuttonPaddingTop - The top spacing of the button.
\nbuttonPaddingLeft - The left spacing of the button.
\nbuttonPaddingRight - The right spacing of the button.
\nbuttonPaddingBottom - The bottom spacing of the button.
\ntextDecoration - A CSS value to set the text decoration of the button text.
\nborderRadius - The roundness of the button corners.
\ntext - The button text.
\nurl - The anchor link for the button.
\nCOLUMN
\ncolumns - An object containing the configuration for each single column. It contains the following parameters:
\ncolumnPadding - The spacing between columns.
\nlayout - A comma-delimited set of integers that sets the number of columns and the size for each column. Each integer represents a column and the value determines how much space that column will take in the parent column module.
\nautoGenerateTextContent [TRUE | FALSE] - If TRUE, the text version of the email will be auto generated based off the content of a SIMPLE customized email. If FALSE, the text content will have to be changes manually. This will always be FALSE for ADVANCED customized emails.
\nhtmlContent (Only usable for ADVANCED customization types) - The HTML content of the email template.
\ntextContent - The plaintext version of the email. If autoGenerateTextContent is TRUE, this value will be ignored.
\nHave Questions?
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 20,\n \"width\": 0,\n \"content\": \"Click below to learn more about the HYPR
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"BUTTON\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"backgroundColor\": \"#1A1288\",\n \"textColor\": \"#FFFFFF\",\n \"fontSize\": 14,\n \"fontWeight\": 500,\n \"buttonPaddingTop\": 5,\n \"buttonPaddingLeft\": 10,\n \"buttonPaddingRight\": 10,\n \"buttonPaddingBottom\": 5,\n \"textDecoration\": \"none\",\n \"borderRadius\": 4,\n \"text\": \"Read the Guide\",\n \"url\": \"https://docs.hypr.com\"\n }\n ]\n },\n {\n \"modules\": [\n {\n \"type\": \"TEXT\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"content\": \"Download the HYPR app now.
\",\n \"color\": \"inherit\",\n \"textAlign\": \"CENTER\"\n },\n {\n \"type\": \"IMAGE\",\n \"placement\": \"COLUMN\",\n \"paddingTop\": 0,\n \"paddingLeft\": 0,\n \"paddingRight\": 0,\n \"paddingBottom\": 10,\n \"width\": 0,\n \"alt\": \"IOS app\",\n \"imageWidth\": 130,\n \"assetUrl\": \"https://hypr.com/static/images/app-badge.png\",\n \"link\": \"https://hypr.com/download-app\"\n }\n ]\n }\n ],\n \"columnPadding\": 10,\n \"layout\": \"1,1\"\n }\n ],\n \"autoGenerateTextContent\": true,\n \"htmlContent\": null,\n \"textContent\": \"Welcome to HYPR\\nClick Here to Join Now ({{attr:inviteLink}})\\nHave Questions?\\nRead the Guide (https://docs.hypr.com)\\nDownload the HYPR app now.\\nhttps://hypr.com/download-app\"\n }\n}"}],"_postman_id":"c04ab83b-b6fa-4fea-8754-9562318bd2be"}],"id":"4ca63c87-9791-4510-836f-a529401c5189","_postman_id":"4ca63c87-9791-4510-836f-a529401c5189","description":"","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}},{"name":"Notification Types","item":[{"name":"Get Notification Types","id":"fcd1abf1-0d39-4a03-a13f-4616ac5f3045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/email/notificationTypes","description":"Added in HYPR version 11.1
\nGet available notification types
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n[\n {\n \"type\": \"<string>\",\n \"requiredAttributes\": [\n \"<string>\"\n ],\n \"optionalAttributes\": [\n \"<string>\"\n ]\n }\n]\n\ntype [AFFIRM_APPROVER_INVITE | AFFIRM_HELPDESK_USER_INVITE | AFFIRM_HELPDESK_USER_RECOVERY | AFFIRM_OTP | AFFIRM_WORKFLOW_INVITE | AUTH_INTEGRATION_USER_INVITE | AUTH_INTEGRATION_USER_RECOVERY | CONTROL_CENTER_USER_INVITE | CONTROL_CENTER_USER_RECOVERY | DEVICE_MANAGER_NEW_DEVICE | ENTRA_NATIVE_INTEGRATION_USER_INVITE | INTEGRATION_USER_INVITE | INTEGRATION_USER_RECOVERY]
\nThe notification type
\nrequiredAttributes
\nThe list of required attribute variable names that will need to be included in a template linked to this notification type.
\noptionalAttributes
\nThe list of attribute variable names that are supported by a template linked to the notification type but are not required to be included in the template.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","email","notificationTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ef72f408-965f-4909-9c29-e80472ad71a2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/email/notificationTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"type\": \"CONTROL_CENTER_USER_INVITE\",\n \"requiredAttributes\": [\n \"inviteLink\",\n \"username\"\n ],\n \"optionalAttributes\": [\n \"firstName\"\n ]\n },\n {\n \"type\": \"CONTROL_CENTER_USER_RECOVERY\",\n \"requiredAttributes\": [\n \"inviteLink\",\n \"username\"\n ],\n \"optionalAttributes\": [\n \"firstName\"\n ]\n }\n]"}],"_postman_id":"fcd1abf1-0d39-4a03-a13f-4616ac5f3045"},{"name":"Get Notification Type Assignments","id":"b827ab9c-570b-448f-b66a-60005ee0a4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/appconfig/email/notification","description":"Added in HYPR version 11.1
\nGet all notification type assignments.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n[\n {\n \"notificationType\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"versionId\": \"<string>\",\n }\n]\n\nnotificationType [AFFIRM_APPROVER_INVITE | AFFIRM_HELPDESK_USER_INVITE | AFFIRM_HELPDESK_USER_RECOVERY | AFFIRM_OTP | AFFIRM_WORKFLOW_INVITE | AUTH_INTEGRATION_USER_INVITE | AUTH_INTEGRATION_USER_RECOVERY | CONTROL_CENTER_USER_INVITE | CONTROL_CENTER_USER_RECOVERY | DEVICE_MANAGER_NEW_DEVICE | ENTRA_NATIVE_INTEGRATION_USER_INVITE | INTEGRATION_USER_INVITE | INTEGRATION_USER_RECOVERY]
\nThe notification type
\ncustomizationId
\nThe ID of the assigned template
\nversionId
\nThe ID of the assigned template version
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","appconfig","email","notification"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a1210543-ac84-49e8-b930-6ad05e33ea94","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/cc/api/appconfig/email/notification"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"notificationType\": \"CONTROL_CENTER_USER_INVITE\",\n \"customizationId\": \"611039403634360320\",\n \"versionId\": \"13f17818\"\n },\n {\n \"notificationType\": \"CONTROL_CENTER_USER_RECOVERY\",\n \"customizationId\": \"611039403634360321\",\n \"versionId\": \"13f17820\"\n }\n]"}],"_postman_id":"b827ab9c-570b-448f-b66a-60005ee0a4b1"},{"name":"Set Notification Type Assignment","id":"1329a1f2-c777-4e47-a049-55edddc585d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"notificationType\": \"CONTROL_CENTER_USER_INVITE\",\n \"customizationId\": \"608553537993572352\",\n \"versionId\": \"479bcb49\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/appconfig/email/notification","description":"Added in HYPR version 11.1
\nAssign a template to a notification type.
\n200 OK
Indicates success.
An RFC7807 formatted error will be returned when a request cannot be completed.
\n{\n \"notificationType\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"versionId\": \"<string>\"\n}\n\nnotificationType [AFFIRM_APPROVER_INVITE | AFFIRM_HELPDESK_USER_INVITE | AFFIRM_HELPDESK_USER_RECOVERY | AFFIRM_OTP | AFFIRM_WORKFLOW_INVITE | AUTH_INTEGRATION_USER_INVITE | AUTH_INTEGRATION_USER_RECOVERY | CONTROL_CENTER_USER_INVITE | CONTROL_CENTER_USER_RECOVERY | DEVICE_MANAGER_NEW_DEVICE | ENTRA_NATIVE_INTEGRATION_USER_INVITE | INTEGRATION_USER_INVITE | INTEGRATION_USER_RECOVERY]
\nThe notification type
\ncustomizationId
\nThe ID of the template being assigned
\nversionId
\nThe ID of the template version being assigned
\n{\n \"notificationType\": \"<string>\",\n \"customizationId\": \"<string>\",\n \"versionId\": \"<string>\"\n}\n\nnotificationType [AFFIRM_APPROVER_INVITE | AFFIRM_HELPDESK_USER_INVITE | AFFIRM_HELPDESK_USER_RECOVERY | AFFIRM_OTP | AFFIRM_WORKFLOW_INVITE | AUTH_INTEGRATION_USER_INVITE | AUTH_INTEGRATION_USER_RECOVERY | CONTROL_CENTER_USER_INVITE | CONTROL_CENTER_USER_RECOVERY | DEVICE_MANAGER_NEW_DEVICE | ENTRA_NATIVE_INTEGRATION_USER_INVITE | INTEGRATION_USER_INVITE | INTEGRATION_USER_RECOVERY]
\nThe notification type
\ncustomizationId
\nThe ID of the template assigned
\nversionId
\nThe ID of the template version assigned
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}},"urlObject":{"path":["cc","api","appconfig","email","notification"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0086dc00-eec1-4f22-97e7-8c049694bb3c","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"notificationType\": \"CONTROL_CENTER_USER_INVITE\",\n \"customizationId\": \"608553537993572352\",\n \"versionId\": \"479bcb49\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/cc/api/appconfig/email/notification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"notificationType\": \"CONTROL_CENTER_USER_INVITE\",\n \"customizationId\": \"608553537993572352\",\n \"versionId\": \"479bcb49\"\n}"}],"_postman_id":"1329a1f2-c777-4e47-a049-55edddc585d9"}],"id":"bc790198-f3a0-4da9-8e4c-a4b018d01451","_postman_id":"bc790198-f3a0-4da9-8e4c-a4b018d01451","description":"","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":true,"source":{"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d","name":"Control Center","type":"folder"}}}],"id":"a55ecaf8-1bc4-4714-97ba-255d4abf944f","description":"Control and manage the look and feel of the email notifications sent from the Control Center.
\nAll API calls require a bearer token for the controlCenterAdmin relying party app plus the following scope(s):
\nhypr:affirm:admin)Manage functions that are specific to only Control Center and can only accept the controlCenterAdmin API token. Authorization for this folder is set by default to use the [token-ccadmin] Bearer Token. All calls under Control Center subfolders inherit their Bearer Token from this folder.
\nCalls affecting the controlCenterAdmin RP Application settings are found under RP Applications.
\nSee our Product Documentation Authenticate section for a full description of Control Center and its capabilities.
\n","auth":{"type":"bearer","bearer":{"token":"{{token_ccadmin}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"79028831-243b-4f3c-9387-a3ecd3ca169e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"11353a63-ab64-4294-8b8a-94dd60800d4c"}}],"_postman_id":"dce3c844-85aa-48f2-99de-8cf3bc3aa58d"},{"name":"RP Applications","item":[{"name":"Application Properties","item":[{"name":"Policy Management","item":[{"name":"Authenticators","item":[{"name":"Disable authenticator.","id":"604e87ae-dd18-42f1-a71d-233233fd6f8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"aaid\": \"Disables an authenticator for a specific RP application.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 6.7.0.
\n200 OK
{\n \"aaid\": \"string\"\n}\n\naaid
The Authenticator Attestation Identifier for a specific authenticator, for example the HYPR Android 4-Digit Passcode Authenticator. Takes a 9-character string of the form NNNN#NNNN (e.g., 0045#1006) or a 32-character aaid (e.g., ee882879721c491397753dfcce97072a).
{\n \"success\": <boolean>,\n \"message\": \"<string>\"\n}\n\nsuccess
The value is true when the authenticator is successfully disabled, false otherwise.
[ true | false ]
message
The success/failure message.
Enables an authenticator for a specific RP application.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 6.7.0.
\n200 OK
{\n \"aaid\": \"<string>\"\n}\n\naaid
The Authenticator Attestation Identifier for a specific authenticator, for example the HYPR Android 4-Digit Passcode Authenticator. Takes a 9-character string of the form NNNN#NNNN (e.g., 0045#1006) or a 32-character aaid (e.g., ee882879721c491397753dfcce97072a).
{\n \"success\": <boolean>,\n \"message\": \"<string>\"\n}\n\nsuccess
The value is true when the authenticator is successfully enabled, and false otherwise.
message
The success/failure message.
Enable and disable a specific authenticator AAGUID across the entire RP Application.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a0450758-fb35-4455-80e3-9a981082576b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"903a1617-2962-4f24-a37f-20598b0c3749"}}],"_postman_id":"e5c2167c-102b-48bf-bcb2-5551bd935f09"},{"name":"Retrieve authentication policies.","id":"c437b43c-91b7-4414-87a6-41bb245da4ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{baseUrl}}/cc/api/action","description":"Retrieves the authentication policies for an RP application. A policy consists of a numbered set (1 - 5) of individual or chained authenticators.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 7.4.0.
\n200 OK
The Request Body is empty.
\n[\n {\n \"id\": <integer>,\n \"createDate\": \"<string>\",\n \"lastModifiedDate\": \"<string>\",\n \"loginAuthenticators\": [\n {\n \"id\": <integer>,\n \"createDate\": \"<string>\",\n \"type\": \"<string>\",\n \"appId\": \"<string>\",\n \"sessionLength\": <integer>,\n \"tenantId\": <integer>\n },\n {\n ...\n }\n ],\n \"name\": \"<string>\",\n \"setId\": <integer>,\n \"codeName\": \"<string>\",\n \"category\": \"<string>\",\n \"description\": \"<string>\",\n \"tenantId\": <integer>\n }\n]\n\nid
The HYPR-generated identifier for this authentication policy.
createDate
The date this authentication policy was created.
lastModifiedDate
The date this authentication policy was last modified.
loginAuthenticators
The chain of authenticators for this setId. The chain consists of 1 to 5 authenticators to use in sequence, for example: NATIVE followed by VOICE.
NATIVE | PIN | VOICE | PALM | FACE | SILENT | PRESENCE ]name
For HYPR internal use only.
setId
The setId (1 - 5) determines the order in which the authenticator chains are applied, and also the order in which the authenticator chains are displayed in the Control Center.
codeName
The name of the authentication policy displayed in the Control Center.
category
For HYPR internal use only.
description
The description of the authentication policy displayed in the Control Center.
tenantId
The HYPR-generated identifier for the tenant.
Create a new authentication policy action in the Control Center. Each action can be comprised of one or more methods. For instance, the default policy defaultRegAction includes both NATIVE and PIN methods.
\nThe Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.
\nAdded in HYPR version 7.4.0.
\n200 OK
id
A unique identifier for the policy action.
codeName
The name of the authentication policy displayed in the Control Center.
name
The name of the authentication policy displayed in the Control Center.
description
The description of the authentication policy displayed in the Control Center.
appId
The camel case unique RP application identifier.
actionSetMap:
\n