{"openapi":"3.0.0","info":{"title":"Accounts API","version":"2.0","description":"Use this API to programmatically manage your Telesign accounts and their configurations.\n","contact":{"email":"support@telesign.com","name":"Telesign Customer Support Team"}},"servers":[{"url":"accounts.telesign.com"}],"paths":{"/accounts/{source_account_id}":{"parameters":[{"schema":{"type":"string"},"name":"source_account_id","in":"path","required":true,"description":"Identifies the source account to clone."}],"post":{"summary":"Clone account","operationId":"cloneAccount","responses":{"201":{"description":"**Success.** The new account was successfully created.\n\n\nStatus code | Associated text string\n--|--\n5005|New account was successfully created.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5005},"description":{"type":"string","example":"New account was successfully created."}}},"data":{"$ref":"#/components/schemas/Account"}}}]},"examples":{"Success":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5005,"description":"New account was successfully created."},"data":{"account_id":"ABC1DE23-A12B-1234-56AB-AB1234567890","users":[{"first_name":"Jane","last_name":"Smith","phone":"11234567890","email":"jsmith@vero-finto.com"}],"account_name":"Vero-Finto"}}}}}}},"400":{"description":"**Bad Request.**\n\n\nStatus code | Associated text string \n--|-- \n5101|Invalid value for body parameter {param name}.\n5103|Invalid value for path parameter {param name} \n5110|Request payload is improperly formatted.\n5112|Missing required parameter {param_name}. \n5114|Resource not found\n\n","content":{"application/json":{"schema":{"type":"object","x-examples":{"Example 1":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5103,"description":"Invalid value for path parameter source_account_id"}}},"properties":{"reference_id":{"type":"string","description":"A unique, randomly generated hex value that identifies your web service request.","example":"0123456789ABCDEF0123456789ABCDEF"},"status":{"type":"object","description":"Contains properties related to the processing status of the transaction.","properties":{"code":{"type":"integer","example":5103,"description":"A numeric code that indicates the status of your transaction."},"description":{"type":"string","example":"Invalid value for path parameter source_account_id","description":"Text describing the status of your transaction."}}}}},"examples":{"Invalid value for path parameter":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5103,"description":"Invalid value for path parameter source_account_id"}}}}}}},"401":{"$ref":"#/components/responses/AccountsShared401"},"403":{"$ref":"#/components/responses/AccountsShared403"},"429":{"$ref":"#/components/responses/AccountsShared429"},"503":{"$ref":"#/components/responses/AccountsShared503"}},"description":"> 📘 NOTE:\n> \n> Accounts API is currently available on a limited basis. Contact our [Customer Support Team](mailto:support@telesign.com) if you’d like to explore using this API.\n\nUse this endpoint to clone an account. The account corresponding to the account ID in the path of your request is used as the source account. Configuration properties of the source account are applied to the new account. \n\nYou may include contact details for an initial user in the request. Telesign uses those details to send an invitation to sign in to that user, so it's important to ensure that info is valid. You can manually create additional users in your account.\n\nUsers and permissions are not copied from the source account.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Encoding:** Accepts only **UTF-8 unicode** characters as inputs.\n* **Accepts:** `application/json`\n* **Responds with:** `application/json`\n* **Required headers:** `Content-Type - application/json`\n","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AccountDetails"},{"type":"object","properties":{"users":{"type":"array","minItems":0,"maxItems":1,"description":"All new users to be created and given access to this account. Do not include existing users from your organization.","items":{"type":"object"}}}}]},"examples":{"Request Payload":{"value":{"account_name":"Vero-Finto","users":[{"first_name":"Jane","last_name":"Smith","phone":"11234567890","email":"jsmith@vero-finto.com"}]}}}}},"description":""},"parameters":[],"tags":["Accounts"]}},"/scim/v2/ServiceProviderConfig":{"get":{"tags":["SCIM"],"summary":"Get Service Provider Config","description":"List the capabilities of this service.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"get_service_provider_config_scim_v2_ServiceProviderConfig_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimServiceProviderConfig"}}}}}}},"/scim/v2/ResourceTypes":{"get":{"tags":["SCIM"],"summary":"List Resource Types","description":"List the Resource Types included in this service.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"list_resource_types_scim_v2_ResourceTypes_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimListResponse"}}}}}}},"/scim/v2/ResourceTypes/{resource_type_name}":{"get":{"tags":["SCIM"],"summary":"Get Resource Type","description":"Retrieve one Resource Type by name.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"get_resource_type_scim_v2_ResourceTypes__resource_type_name__get","parameters":[{"required":true,"schema":{"title":"Resource Type Name","type":"string"},"name":"resource_type_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimResourceType"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Schemas":{"get":{"tags":["SCIM"],"summary":"List Schemas","description":"List the Schemas used by this service.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"list_schemas_scim_v2_Schemas_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimListResponse"}}}}}}},"/scim/v2/Schemas/{schema_id}":{"get":{"tags":["SCIM"],"summary":"Get Schema","description":"Retrieve one Schema by ID.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"get_schema_scim_v2_Schemas__schema_id__get","parameters":[{"required":true,"schema":{"title":"Schema Id","type":"string"},"name":"schema_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSchemaDefinition"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Users":{"get":{"tags":["SCIM"],"summary":"Get Users","description":"List all Users for this instance.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"get_users_scim_v2_Users_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimListResponse"}}}}}},"post":{"tags":["SCIM"],"summary":"Create User","description":"Create one User for your instance.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"create_user_scim_v2_Users_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimUserRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Users/{user_id}":{"get":{"tags":["SCIM"],"summary":"Retrieve User","description":"Retrieve one User by ID.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"retrieve_user_scim_v2_Users__user_id__get","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["SCIM"],"summary":"Update User","description":"Replace all details for one existing User by ID.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"update_user_scim_v2_Users__user_id__put","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["SCIM"],"summary":"Delete User","description":"Deprovision one User by ID. Note that instead of deleting the user, its active status is set to `false`.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"delete_user_scim_v2_Users__user_id__delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["SCIM"],"summary":"Patch Update User","description":"Modify one existing User by ID.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"patch_update_user_scim_v2_Users__user_id__patch","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimPatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Groups":{"get":{"tags":["SCIM"],"summary":"Get Groups","description":"List all Groups for this instance.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"get_groups_scim_v2_Groups_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimListResponse"}}}}}}},"/scim/v2/Groups/{group_id}":{"get":{"tags":["SCIM"],"summary":"Retrieve Group","description":"Retrieve one Group by ID.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"retrieve_group_scim_v2_Groups__group_id__get","parameters":[{"required":true,"schema":{"title":"Group Id","type":"string"},"name":"group_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["SCIM"],"summary":"Update Group","description":"Modify one existing Group by ID.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication)\n* **Responds with:** `application/json`","operationId":"update_group_scim_v2_Groups__group_id__patch","parameters":[{"required":true,"schema":{"title":"Group Id","type":"string"},"name":"group_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimPatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimGroup"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/keys":{"parameters":[],"get":{"summary":"List REST API keys","operationId":"listRestAPIKeys","responses":{"200":{"description":"**Success.** A list of REST API key objects associated with this account was successfully returned.\n\nStatus code | Associated text string\n--|--\n5001|Key list was successfully retrieved.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"data":{"type":"object","description":"Contains REST API key data. ","properties":{"keys":{"type":"array","minItems":1,"maxItems":10,"uniqueItems":true,"items":{"$ref":"#/components/schemas/RestAPIKey"}}}},"status":{"type":"object","properties":{"code":{"type":"integer","example":5001},"description":{"type":"string","example":"Key list was successfully retrieved."}}}}}]},"examples":{"Success":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5001,"description":"Key list was successfully retrieved."},"data":{"keys":[{"key_id":"123456","last_updated":"2024-01-01T00:00:00Z","expiration_date":"2026-09-05T00:00:00Z"}]}}}}}}},"401":{"$ref":"#/components/responses/AccountsShared401"},"403":{"$ref":"#/components/responses/AccountsShared403"},"429":{"$ref":"#/components/responses/AccountsShared429"},"503":{"$ref":"#/components/responses/AccountsShared503"}},"description":"> 📘 NOTE:\n> \n> Accounts API is currently available on a limited basis. Contact our [Customer Support Team](mailto:support@telesign.com) if you’d like to explore using this API.\n\nUse this action to list details related to all REST API keys for this account. The key values are not returned.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Responds with:** `application/json`\n","parameters":[],"tags":["API Keys"]},"post":{"summary":"Create new REST API key","operationId":"post-accounts-account_id-keys-rest","responses":{"201":{"description":"**Success.** A new REST API key was successfully created for this account.\n\nStatus code | Associated text string\n--|--\n5000|New key was successfully created.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/RestAPIKey"},{"type":"object","properties":{"key":{"type":"string","description":"The value of the REST API key.","example":"ABC12345yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="}}}],"description":"Contains REST API key data. "}}},{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5000},"description":{"type":"string","example":"New key was successfully created."}}}}}]},"examples":{"Success":{"value":{"data":{"key_id":"123456","last_updated":"2024-01-01T00:00:00Z","expiration_date":"2026-09-05T00:00:00Z","key":"ABC12345yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==\n"},"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5000,"description":"New key was successfully created."}}}}}}},"400":{"description":"**Bad Request.**\n\nStatus code | Associated text string\n--|--\n5101|Invalid value for body parameter {param name}.\n5110|Request payload is improperly formatted.\n5111|The limit of {max_no_keys} keys has been reached.\n5112|Missing required parameter {param_name}.\n5113|{date-time-stamp} is not a valid future date.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5101},"description":{"type":"string","example":"Invalid value for body parameter expiration_date."}}}}}]},"examples":{"Invalid body param":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5101,"description":"Invalid value for body parameter expiration_date."}}}}}}},"401":{"$ref":"#/components/responses/AccountsShared401"},"403":{"$ref":"#/components/responses/AccountsShared403"},"429":{"$ref":"#/components/responses/AccountsShared429"},"503":{"$ref":"#/components/responses/AccountsShared503"}},"description":"> 📘 NOTE:\n> \n> Accounts API is currently available on a limited basis. Contact our [Customer Support Team](mailto:support@telesign.com) if you’d like to explore using this API.\n\nUse this action to create a new REST API key for this Telesign account.\n\nThis is the only action of this API that returns the key’s value. Be sure to map it to the key ID in a secure fashion on your own system.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Encoding:** Accepts only **UTF-8 unicode** characters as inputs.\n* **Accepts:** `application/json`\n* **Responds with:** `application/json`\n* **Required headers:** `Content-Type - application/json`\n\n","tags":["API Keys"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","x-examples":{"Example 1":{"expiration_date":""}},"properties":{"expiration_date":{"type":"string","example":"2026-09-05T00:00:00Z","description":"The expiration date of this REST API key. A value of `never` indicates that this key never expires."}},"required":["expiration_date"]},"examples":{"Request body":{"value":{"expiration_date":"2026-09-05T00:00:00Z"}}}},"application/xml":{"schema":{"type":"object","properties":{}}}},"description":""}}},"/keys/{key_id}":{"parameters":[{"$ref":"#/components/parameters/key_id"}],"get":{"summary":"Get one REST API key","tags":["API Keys"],"responses":{"200":{"description":"**Success**. The specified key object was successfully returned.\n\nStatus code | Associated text string\n--|--\n5002| Key object was successfully retrieved.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RestAPIKey"},"status":{"type":"object","properties":{"code":{"type":"integer","example":5002},"description":{"type":"string","example":"Key object was successfully retrieved."}}}}}]},"examples":{"Success":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5002,"description":"Key object was successfully retrieved."},"data":{"key_id":"123456","last_updated":"2024-01-01T00:00:00Z","expiration_date":"2026-09-05T00:00:00Z"}}}}}}},"400":{"description":"**Bad Request.**\n\nStatus code | Associated text string\n--|--\n5103|Invalid value for path parameter {param name}\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5103},"description":{"type":"string","example":"Invalid value for path parameter key_id"}}}}}]},"examples":{"Invalid path parameter":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5103,"description":"Invalid value for path parameter key_id"}}}}}}},"401":{"$ref":"#/components/responses/AccountsShared401"},"403":{"$ref":"#/components/responses/AccountsShared403"},"429":{"$ref":"#/components/responses/AccountsShared429"},"503":{"$ref":"#/components/responses/AccountsShared503"}},"operationId":"get-accounts-account_id-keys-rest-key_id","description":"> 📘 NOTE:\n> \n> Accounts API is currently available on a limited basis. Contact our [Customer Support Team](mailto:support@telesign.com) if you’d like to explore using this API.\n\nUse this action to list details related to the provided REST API key ID. The key value is not returned.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Responds with:** `application/json`\n"},"delete":{"summary":"Remove REST API key","operationId":"delete-accounts-account_id-keys-rest-key_id","responses":{"200":{"description":"**Success.** The specified REST API key has been successfully expired and removed from the list of active keys for this account.\n\nStatus code | Associated text string\n--|--\n5004|Key successfully expired.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5004},"description":{"type":"string","example":"Key successfully expired."}}}}}]},"examples":{"Success":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5004,"description":"Key successfully expired."}}}}}}},"400":{"description":"**Bad Request.**\n\nStatus code | Associated text string\n--|--\n5103|Invalid value for path parameter {param name}","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5103},"description":{"type":"string","example":"Invalid value for path parameter key_id"}}}}}]},"examples":{"Invalid path parameter":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5103,"description":"Invalid value for path parameter key_id"}}}}}}},"401":{"$ref":"#/components/responses/AccountsShared401"},"403":{"$ref":"#/components/responses/AccountsShared403"},"429":{"$ref":"#/components/responses/AccountsShared429"},"503":{"$ref":"#/components/responses/AccountsShared503"}},"description":"> 📘 NOTE:\n> \n> Accounts API is currently available on a limited basis. Contact our [Customer Support Team](mailto:support@telesign.com) if you’d like to explore using this API.\n\nUse this action to expire this REST API key immediately.\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Responds with:** `application/json`\n","tags":["API Keys"]},"patch":{"summary":"Update REST API key","operationId":"patch-accounts-account_id-keys-rest-key_id","responses":{"200":{"description":"**Success** The specified REST API key has been succesfully updated and the key object with its new details has been returned.\n\nStatus code | Associated text string\n--|--\n5003|Key was successfully updated.\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RestAPIKey"},"status":{"type":"object","properties":{"code":{"type":"integer","example":5003},"description":{"type":"string","example":"Key was successfully updated."}}}}}]},"examples":{"Success":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5003,"description":"Key was successfully updated."},"data":{"key_id":"123456","last_updated":"2024-01-01T00:00:00Z","expiration_date":"2026-09-05T00:00:00Z"}}}}}}},"400":{"description":"**Bad Request.**\n\nStatus code | Associated text string\n--|--\n5101|Invalid value for body parameter {param name}. \n5103|Invalid value for path parameter {param name}\n5110|Request payload is improperly formatted.\n5112|Missing required parameter {param_name}.\n5113|{date-time-stamp} is not a valid future date.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5103},"description":{"type":"string","example":"Invalid value for path parameter key_id"}}}}}]},"examples":{"Invalid path parameter":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5103,"description":"Invalid value for path parameter key_id"}}}}}}},"401":{"$ref":"#/components/responses/AccountsShared401"},"403":{"$ref":"#/components/responses/AccountsShared403"},"429":{"$ref":"#/components/responses/AccountsShared429"},"503":{"$ref":"#/components/responses/AccountsShared503"}},"description":"> 📘 NOTE:\n> \n> Accounts API is currently available on a limited basis. Contact our [Customer Support Team](mailto:support@telesign.com) if you’d like to explore using this API.\n\nUse this action to update a REST API key. This is used to set an expiration date for a key, change the expiration date, or remove the expiration date (making it a non-expiring key).\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Encoding:** Accepts only **UTF-8 unicode** characters as inputs.\n* **Accepts:** `application/json`\n* **Responds with:** `application/json`\n* **Required headers:** `Content-Type - application/json`\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expiration_date":{"type":"string","description":"The expiration date of this REST API key. A value of `never` indicates that this key never expires.","example":"2026-09-05T00:00:00Z"}},"required":["expiration_date"]},"examples":{"Request body":{"value":{"expiration_date":"2026-09-05T00:00:00Z"}}}},"application/xml":{"schema":{"type":"object","properties":{}}}},"description":""},"tags":["API Keys"]}}},"components":{"schemas":{"UserDetails":{"title":"UserDetails","type":"object","properties":{"first_name":{"type":"string","description":"The user's given name.","example":"Jane"},"last_name":{"type":"string","description":"The user's surname.","example":"Smith"},"phone":{"type":"string","description":"The contact phone number associated with this user. This is used for MFA when the user signs in. Include the country code. Do not include special characters or spaces.","example":"11234567890"},"email":{"type":"string","description":"The contact email address for this user.","example":"jsmith@vero-finto.com"}},"required":["first_name","last_name","phone","email"]},"AccountDetails":{"title":"AccountDetails","type":"object","properties":{"account_name":{"type":"string","description":"The name of this account. This must be unique within your organization.","example":"Vero-Finto"},"users":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/UserDetails"}}},"required":["account_name","users"]},"Account":{"title":"Account","allOf":[{"type":"object","properties":{"account_id":{"type":"string","description":"A unique identifier for this account.","example":"ABC1DE23-A12B-1234-56AB-AB1234567890"},"users":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/UserDetails"}}},"required":["account_id","users"]},{"$ref":"#/components/schemas/AccountDetails"}]},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RestAPIKey":{"title":"RestAPIKey","allOf":[{"type":"object","properties":{"key_id":{"type":"string","description":"A unique identifier for managing this REST API key. Cannot be used as a token to authenticate REST API requests.","example":"123456"}}},{"$ref":"#/components/schemas/RestAPIKeyDetails"}]},"RestAPIKeyDetails":{"type":"object","properties":{"last_updated":{"type":"string","description":"When this REST API key was last updated.","example":"2024-01-01T00:00:00Z"},"expiration_date":{"type":"string","description":"The expiration date of this REST API key. A value of `never` indicates that this key never expires.","example":"2025-01-01T00:00:00Z"}}},"ScimAttributeType":{"title":"ScimAttributeType","enum":["string","boolean","decimal","integer","dateTime","reference","complex"],"type":"string","description":"An enumeration."},"ScimAuthScheme":{"title":"ScimAuthScheme","required":["type","name","description"],"type":"object","properties":{"type":{"title":"Type","type":"string"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"specUri":{"title":"Specuri","maxLength":65536,"minLength":1,"type":"string","format":"uri"},"documentationUri":{"title":"Documentationuri","maxLength":65536,"minLength":1,"type":"string","format":"uri"},"primary":{"title":"Primary","type":"boolean"}}},"ScimBulkSupport":{"title":"ScimBulkSupport","required":["supported","maxOperations","maxPayloadSize"],"type":"object","properties":{"supported":{"title":"Supported","type":"boolean"},"maxOperations":{"title":"Maxoperations","type":"integer"},"maxPayloadSize":{"title":"Maxpayloadsize","type":"integer"}}},"ScimEmail":{"title":"ScimEmail","required":["value","type"],"type":"object","properties":{"value":{"title":"Value","type":"string","format":"email"},"type":{"$ref":"#/components/schemas/ScimType"},"primary":{"title":"Primary","type":"boolean"},"display":{"title":"Display","type":"string"}}},"ScimFilterSupport":{"title":"ScimFilterSupport","required":["supported","maxResults"],"type":"object","properties":{"supported":{"title":"Supported","type":"boolean"},"maxResults":{"title":"Maxresults","type":"integer"}}},"ScimGroup":{"title":"ScimGroup","required":["displayName"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:schemas:core:2.0:Group"]},"id":{"title":"Id","type":"string"},"externalId":{"title":"Externalid","type":"string"},"displayName":{"title":"Displayname","type":"string"},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/ScimGroupMember"}},"meta":{"$ref":"#/components/schemas/ScimMeta"}}},"ScimGroupMember":{"title":"ScimGroupMember","required":["value"],"type":"object","properties":{"value":{"title":"Value","type":"string"},"display":{"title":"Display","type":"string"},"ref":{"title":"Ref","type":"string"}}},"ScimListResponse":{"title":"ScimListResponse","required":["totalResults"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"totalResults":{"title":"Totalresults","type":"integer"},"startIndex":{"title":"Startindex","type":"integer","default":1},"itemsPerPage":{"title":"Itemsperpage","type":"integer"},"Resources":{"title":"Resources","type":"array","items":{}}}},"ScimMeta":{"title":"ScimMeta","type":"object","properties":{"resourceType":{"title":"Resourcetype","type":"string"},"created":{"title":"Created","type":"string","format":"date-time"},"location":{"title":"Location","maxLength":65536,"minLength":1,"type":"string","format":"uri"}}},"ScimMutability":{"title":"ScimMutability","enum":["readOnly","readWrite","immutable","writeOnly"],"type":"string","description":"An enumeration."},"ScimName":{"title":"ScimName","required":["familyName","givenName"],"type":"object","properties":{"formatted":{"title":"Formatted","type":"string"},"familyName":{"title":"Familyname","type":"string"},"givenName":{"title":"Givenname","type":"string"},"middleName":{"title":"Middlename","type":"string"}}},"ScimPatchOp":{"title":"ScimPatchOp","enum":["add","replace","remove"],"type":"string","description":"An enumeration."},"ScimPatchOperation":{"title":"ScimPatchOperation","required":["op"],"type":"object","properties":{"op":{"$ref":"#/components/schemas/ScimPatchOp"},"path":{"title":"Path","type":"string"},"value":{"title":"Value"}}},"ScimPatchRequest":{"title":"ScimPatchRequest","required":["Operations"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]},"Operations":{"title":"Operations","type":"array","items":{"$ref":"#/components/schemas/ScimPatchOperation"}}}},"ScimPhoneNumber":{"title":"ScimPhoneNumber","required":["value","type"],"type":"object","properties":{"value":{"title":"Value","type":"string"},"type":{"$ref":"#/components/schemas/ScimType"},"primary":{"title":"Primary","type":"boolean"},"display":{"title":"Display","type":"string"}}},"ScimResourceType":{"title":"ScimResourceType","required":["id","name","endpoint","schema"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]},"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"endpoint":{"title":"Endpoint","type":"string"},"schema":{"title":"Schema","type":"string"},"schemaExtensions":{"title":"Schemaextensions","type":"array","items":{"$ref":"#/components/schemas/ScimResourceTypeSchemaExtension"},"default":[]},"meta":{"$ref":"#/components/schemas/ScimMeta"}}},"ScimResourceTypeSchemaExtension":{"title":"ScimResourceTypeSchemaExtension","required":["schema","required"],"type":"object","properties":{"schema":{"title":"Schema","type":"string"},"required":{"title":"Required","type":"boolean"}}},"ScimReturned":{"title":"ScimReturned","enum":["always","never","default","request"],"type":"string","description":"An enumeration."},"ScimSchemaAttribute":{"title":"ScimSchemaAttribute","required":["name"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/ScimAttributeType"}],"default":"string"},"multiValued":{"title":"Multivalued","type":"boolean","default":false},"description":{"title":"Description","type":"string"},"required":{"title":"Required","type":"boolean","default":false},"caseExact":{"title":"Caseexact","type":"boolean","default":false},"mutability":{"allOf":[{"$ref":"#/components/schemas/ScimMutability"}],"default":"readWrite"},"returned":{"allOf":[{"$ref":"#/components/schemas/ScimReturned"}],"default":"default"},"uniqueness":{"allOf":[{"$ref":"#/components/schemas/ScimUniqueness"}],"default":"none"},"subAttributes":{"title":"Subattributes","type":"array","items":{"$ref":"#/components/schemas/ScimSchemaAttribute"}}}},"ScimSchemaDefinition":{"title":"ScimSchemaDefinition","required":["id","name"],"type":"object","properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"attributes":{"title":"Attributes","type":"array","items":{"$ref":"#/components/schemas/ScimSchemaAttribute"},"default":[]},"meta":{"$ref":"#/components/schemas/ScimMeta"}}},"ScimServiceProviderConfig":{"title":"ScimServiceProviderConfig","required":["patch","bulk","filter","changePassword","sort","etag","authenticationSchemes","meta"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]},"documentationUri":{"title":"Documentationuri","maxLength":65536,"minLength":1,"type":"string","format":"uri"},"patch":{"$ref":"#/components/schemas/ScimSupported"},"bulk":{"$ref":"#/components/schemas/ScimBulkSupport"},"filter":{"$ref":"#/components/schemas/ScimFilterSupport"},"changePassword":{"$ref":"#/components/schemas/ScimSupported"},"sort":{"$ref":"#/components/schemas/ScimSupported"},"etag":{"$ref":"#/components/schemas/ScimSupported"},"authenticationSchemes":{"title":"Authenticationschemes","type":"array","items":{"$ref":"#/components/schemas/ScimAuthScheme"}},"meta":{"$ref":"#/components/schemas/ScimMeta"}}},"ScimSupported":{"title":"ScimSupported","required":["supported"],"type":"object","properties":{"supported":{"title":"Supported","type":"boolean"}}},"ScimType":{"title":"ScimType","enum":["work","mobile","home","other"],"type":"string","description":"An enumeration."},"ScimUniqueness":{"title":"ScimUniqueness","enum":["none","server","global"],"type":"string","description":"An enumeration."},"ScimUser":{"title":"ScimUser","required":["userName","name","active","emails"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:schemas:core:2.0:User"]},"id":{"title":"Id","type":"string"},"externalId":{"title":"Externalid","type":"string"},"userName":{"title":"Username","type":"string"},"name":{"$ref":"#/components/schemas/ScimName"},"active":{"title":"Active","type":"boolean"},"emails":{"title":"Emails","type":"array","items":{"$ref":"#/components/schemas/ScimEmail"}},"groups":{"title":"Groups","type":"array","items":{"$ref":"#/components/schemas/ScimUserGroup"}},"meta":{"$ref":"#/components/schemas/ScimMeta"}}},"ScimUserGroup":{"title":"ScimUserGroup","required":["value"],"type":"object","properties":{"value":{"title":"Value","type":"string"},"display":{"title":"Display","type":"string"},"ref":{"title":"Ref","maxLength":65536,"minLength":1,"type":"string","format":"uri"}}},"ScimUserRequest":{"title":"ScimUserRequest","required":["userName","name","active","emails","phoneNumbers"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:schemas:core:2.0:User"]},"id":{"title":"Id","type":"string"},"externalId":{"title":"Externalid","type":"string"},"userName":{"title":"Username","type":"string"},"name":{"$ref":"#/components/schemas/ScimName"},"active":{"title":"Active","type":"boolean"},"emails":{"title":"Emails","type":"array","items":{"$ref":"#/components/schemas/ScimEmail"}},"groups":{"title":"Groups","type":"array","items":{"$ref":"#/components/schemas/ScimUserGroup"}},"meta":{"$ref":"#/components/schemas/ScimMeta"},"phoneNumbers":{"title":"Phonenumbers","type":"array","items":{"$ref":"#/components/schemas/ScimPhoneNumber"}}}},"ScimUserResponse":{"title":"ScimUserResponse","required":["userName","name","active","emails"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"default":["urn:ietf:params:scim:schemas:core:2.0:User"]},"id":{"title":"Id","type":"string"},"externalId":{"title":"Externalid","type":"string"},"userName":{"title":"Username","type":"string"},"name":{"$ref":"#/components/schemas/ScimName"},"active":{"title":"Active","type":"boolean"},"emails":{"title":"Emails","type":"array","items":{"$ref":"#/components/schemas/ScimEmail"}},"groups":{"title":"Groups","type":"array","items":{"$ref":"#/components/schemas/ScimUserGroup"}},"meta":{"$ref":"#/components/schemas/ScimMeta"},"phoneNumbers":{"title":"Phonenumbers","type":"array","items":{"$ref":"#/components/schemas/ScimPhoneNumber"}}}},"SharedResponseFields":{"title":"SharedResponseFields","type":"object","properties":{"reference_id":{"type":"string","description":"A unique, randomly generated hex value that identifies your web service request.","example":"0123456789ABCDEF0123456789ABCDEF"},"status":{"$ref":"#/components/schemas/Status"}}},"Status":{"title":"Status","type":"object","description":"Contains properties related to the processing status of the transaction.","properties":{"code":{"type":"integer","description":"A numeric code that indicates the status of your transaction."},"description":{"type":"string","description":"Text describing the status of your transaction."}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}},"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Easiest to implement. See [Basic Authentication](/enterprise/docs/authentication#basic-authentication) for more details."}},"parameters":{"key_id":{"name":"key_id","in":"path","required":true,"schema":{"type":"string","example":"1234567"},"description":"Unique identifier for managing this REST API key. This is NOT the key’s value, which is used to authenticate REST API requests."}},"responses":{"AccountsShared429":{"description":"**Rate limit exceeded.**\n\nStatus code | Associated text string\n-- | --\n5204 | Rate limit exceeded.\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5204},"description":{"type":"string","example":"Rate limit exceeded."}}}}}]},"examples":{"Rate limit error":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5204,"description":"Rate limit exceeded."}}}}}}},"AccountsShared401":{"description":"**Unauthorized.**\n\nStatus code | Associated text string\n-- | --\n5400 | Authentication failed.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5400},"description":{"type":"string","example":"Authentication failed."}}}}}]},"examples":{"Authentication failed":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5400,"description":"Authentication failed."}}}}}}},"AccountsShared403":{"description":"**Forbidden.**\n\nStatus code | Associated text string\n-- | --\n5401 | No permissions for this resource.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5401},"description":{"type":"string","example":"No permissions for this resource."}}}}}]},"examples":{"Resource forbidden":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5401,"description":"No permissions for this resource."}}}}}}},"AccountsShared503":{"description":"**Service unavailable.**\n\nStatus code | Associated text string\n-- | --\n5500 | System unavailable. Please try again later.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SharedResponseFields"},{"type":"object","properties":{"status":{"type":"object","properties":{"code":{"type":"integer","example":5500},"description":{"type":"string","example":"System unavailable. Please try again later."}}}}}]},"examples":{"System unavailable":{"value":{"reference_id":"0123456789ABCDEF0123456789ABCDEF","status":{"code":5500,"description":"System unavailable. Please try again later."}}}}}}}}},"security":[{"Basic":[]}],"tags":[{"name":"Accounts"},{"name":"API Keys"},{"name":"SCIM"}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true,"samples-enabled":true}}