{"items":[{"type":"link","label":"Verification","link":"/openapi/user/verification.openapi","routeSlug":"/openapi/user/verification.openapi","content":{"contentType":"overview","meta":{"name":"Verification"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"verification.openapi.json","url":"/_bundle/openapi/user/verification.openapi.json?download"},{"kind":"download","label":"verification.openapi.yaml","url":"/_bundle/openapi/user/verification.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Verification","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Verify user data that will enrich their profile"}],"sectionId":"/openapi/user/verification.openapi"}],"sectionId":"/openapi/user/verification.openapi"}]}]}},{"label":"Send verification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/verification.openapi/other/sendverificationemail","routeSlug":"/openapi/user/verification.openapi/other/sendverificationemail","metadata":{"seo":{"title":"Send verification email","description":"Sends a verification email using the specified method (OTP or magic link) to the specified email address for the selected user. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendVerificationEmail","name":"Send verification email","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send verification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a verification email using the specified method (OTP or magic link) to the specified email address for the selected user. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_514","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationEmail"}},"schemaId":"components/schemas/ApiSendVerificationEmail","pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/email/verification/send","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_514"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationEmail"}},"responseCodes":["200","404","409"],"pointer":"/v1/users/{user_id}/email/verification/send","href":"other/sendverificationemail","openApiOperationId":"sendVerificationEmail","summary":"Send verification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiSendVerificationEmail","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationEmail"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationEmailResponse"}},"schemaId":"components/schemas/ApiSendVerificationEmailResponse"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailAlreadyVerified"}},"schemaId":"components/schemas/EmailAlreadyVerified"}],"pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSendVerificationEmailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationEmailResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/EmailAlreadyVerified","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailAlreadyVerified"}}}],"examples":[]}]}]}]},"httpPath":"/v1/users/{user_id}/email/verification/send"},{"label":"Validate email OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/verification.openapi/other/verifyemailotp","routeSlug":"/openapi/user/verification.openapi/other/verifyemailotp","metadata":{"seo":{"title":"Validate email OTP","description":"Validate a one-time passcode (OTP) sent by email. This API is used to verify the email OTP sent to the user. The email will be added to the user profile and marked as verified. The endpoint will not authenticate the user (or create new users), and no tokens are returned. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyEmailOtp","name":"Validate email OTP","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate email OTP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a one-time passcode (OTP) sent by email. This API is used to verify the email OTP sent to the user. The email will be added to the user profile and marked as verified. The endpoint will not authenticate the user (or create new users), and no tokens are returned. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_514","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiValidateVerifyEmailOtpInput"}},"schemaId":"components/schemas/ApiValidateVerifyEmailOtpInput","pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/email/verification/verify","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_514"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiValidateVerifyEmailOtpInput"}},"responseCodes":["200","400","404","409"],"pointer":"/v1/users/{user_id}/email/verification/verify","href":"other/verifyemailotp","openApiOperationId":"verifyEmailOtp","summary":"Validate email OTP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiValidateVerifyEmailOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiValidateVerifyEmailOtpInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiVerifyOtpEmailResponse"}},"schemaId":"components/schemas/ApiVerifyOtpEmailResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidEmailOrPasscode"]}},"exampleIds":["paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidEmailOrPasscode"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailAlreadyVerified"}},"schemaId":"components/schemas/EmailAlreadyVerified"}],"pointer":"/paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiVerifyOtpEmailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiVerifyOtpEmailResponse"}}},{"code":"400","exampleIds":["paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidEmailOrPasscode"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidEmailOrPasscode"]}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/EmailAlreadyVerified","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailAlreadyVerified"}}}],"examples":[]}]}]}]},"httpPath":"/v1/users/{user_id}/email/verification/verify"},{"label":"Send verification SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/verification.openapi/other/sendverificationphone","routeSlug":"/openapi/user/verification.openapi/other/sendverificationphone","metadata":{"seo":{"title":"Send verification SMS","description":"Sends a one-time passcode (OTP) by SMS to the specified phone number for a selected user. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendVerificationPhone","name":"Send verification SMS","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send verification SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a one-time passcode (OTP) by SMS to the specified phone number for a selected user. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_514","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendSmsOtpInput"}},"schemaId":"components/schemas/ApiSendSmsOtpInput","pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/phone/verification/send","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_514"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSendSmsOtpInput"}},"responseCodes":["200","404","409"],"pointer":"/v1/users/{user_id}/phone/verification/send","href":"other/sendverificationphone","openApiOperationId":"sendVerificationPhone","summary":"Send verification SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiSendSmsOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendSmsOtpInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationSmsResponse"}},"schemaId":"components/schemas/ApiSendVerificationSmsResponse"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberAlreadyVerified"}},"schemaId":"components/schemas/PhoneNumberAlreadyVerified"}],"pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSendVerificationSmsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendVerificationSmsResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/PhoneNumberAlreadyVerified","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberAlreadyVerified"}}}],"examples":[]}]}]}]},"httpPath":"/v1/users/{user_id}/phone/verification/send"},{"label":"Validate SMS OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/verification.openapi/other/verifyphoneotp","routeSlug":"/openapi/user/verification.openapi/other/verifyphoneotp","metadata":{"seo":{"title":"Validate SMS OTP","description":"Validate a one-time passcode (OTP) sent by SMS. This API is used to verify the SMS OTP sent to the user. The phone number will be added to the user profile and marked as verified. The endpoint will not authenticate the user (or create new users), and no tokens are returned. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyPhoneOtp","name":"Validate SMS OTP","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate SMS OTP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a one-time passcode (OTP) sent by SMS. This API is used to verify the SMS OTP sent to the user. The phone number will be added to the user profile and marked as verified. The endpoint will not authenticate the user (or create new users), and no tokens are returned. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_514","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiValidateVerifySmsOtpInput"}},"schemaId":"components/schemas/ApiValidateVerifySmsOtpInput","pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/phone/verification/verify","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_514"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiValidateVerifySmsOtpInput"}},"responseCodes":["200","400","404","409"],"pointer":"/v1/users/{user_id}/phone/verification/verify","href":"other/verifyphoneotp","openApiOperationId":"verifyPhoneOtp","summary":"Validate SMS OTP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiValidateVerifySmsOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiValidateVerifySmsOtpInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiVerifySmsResponse"}},"schemaId":"components/schemas/ApiVerifySmsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidPhoneOrPasscode"]}},"exampleIds":["paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidPhoneOrPasscode"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberAlreadyVerified"}},"schemaId":"components/schemas/PhoneNumberAlreadyVerified"}],"pointer":"/paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiVerifySmsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiVerifySmsResponse"}}},{"code":"400","exampleIds":["paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidPhoneOrPasscode"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired","paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidPhoneOrPasscode"]}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}},{"code":"409","schemaId":"components/schemas/PhoneNumberAlreadyVerified","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberAlreadyVerified"}}}],"examples":[]}]}]}]},"httpPath":"/v1/users/{user_id}/phone/verification/verify"}],"store":{"schemaStore":{"components/schemas/ApiSendVerificationEmail":{"id":"components/schemas/ApiSendVerificationEmail","kind":"json-schema","title":"ApiSendVerificationEmail","data":{"type":"object","properties":{"method":{"description":"The verification method to use: 'otp' for one-time passcode, 'link' for magic link","example":"otp","$ref":"#/components/schemas/EmailVerificationMethod"},"email":{"type":"string","example":"name@example.com","description":"Email to send the verification to"},"redirect_uri":{"type":"string","example":"https://www.example.com/verify","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URI where the email link will redirect to. Required when method is 'link'. The verification result will be included as a boolean query parameter called result (for example, https://www.example.com/verify?result=true). This URI must also be configured as an allowed redirect URI in the Admin Portal."},"children":[]}]}]}]},"email_content":{"description":"Texts, logo and color to render email template with","allOf":[{"$ref":"#/components/schemas/EmailContentAttributes"}]},"update_primary":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the request to update the user's current verified primary email. Only applicable when method is 'link'. If the user profile already has a verified primary email, it will override it if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or add it as their secondary email if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"default":false}},"required":["method","email"]}},"components/schemas/ApiSendVerificationEmailResponse":{"id":"components/schemas/ApiSendVerificationEmailResponse","kind":"json-schema","title":"ApiSendVerificationEmailResponse","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Verification email sent"}},"required":["message"]}},"components/schemas/NotFoundHttpError":{"id":"components/schemas/NotFoundHttpError","kind":"json-schema","title":"NotFoundHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":404}},"required":["message","error_code"]}},"components/schemas/EmailAlreadyVerified":{"id":"components/schemas/EmailAlreadyVerified","kind":"json-schema","title":"EmailAlreadyVerified","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Email is already verified in the tenant"},"error_code":{"type":"number","readOnly":true,"example":409}},"required":["message","error_code"]}},"components/schemas/ApiValidateVerifyEmailOtpInput":{"id":"components/schemas/ApiValidateVerifyEmailOtpInput","kind":"json-schema","title":"ApiValidateVerifyEmailOtpInput","data":{"type":"object","properties":{"email":{"type":"string","description":"Email that the OTP was sent to"},"passcode":{"type":"string","description":"Email code to validate"},"update_primary":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the request to update the user's current verified primary email. If the user profile already has a verified primary email, it will override it if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or add it as their secondary email if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"default":false}},"required":["email","passcode"]}},"components/schemas/ApiVerifyOtpEmailResponse":{"id":"components/schemas/ApiVerifyOtpEmailResponse","kind":"json-schema","title":"ApiVerifyOtpEmailResponse","data":{"type":"object","properties":{"result":{"type":"boolean","readOnly":true,"description":"Boolean value indicating if OTP email verification succeeded"}},"required":["result"]}},"components/schemas/ApiSendSmsOtpInput":{"id":"components/schemas/ApiSendSmsOtpInput","kind":"json-schema","title":"ApiSendSmsOtpInput","data":{"type":"object","properties":{"custom_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message to send, must contain {otp} and {app} placeholders to be replaced with one time password and application name. Limited to 140 characters"},"children":[]}]}]}]},"sender_id":{"type":"string","description":"The sender name that appears as the message sender on recipients devices. Limited to 11 characters. Limited support see https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html"},"phone_number":{"type":"string","description":"Phone number to send the OTP to"}},"required":["phone_number"]}},"components/schemas/ApiSendVerificationSmsResponse":{"id":"components/schemas/ApiSendVerificationSmsResponse","kind":"json-schema","title":"ApiSendVerificationSmsResponse","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"SMS sent"}},"required":["message"]}},"components/schemas/PhoneNumberAlreadyVerified":{"id":"components/schemas/PhoneNumberAlreadyVerified","kind":"json-schema","title":"PhoneNumberAlreadyVerified","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Phone number is already verified in the tenant"},"error_code":{"type":"number","readOnly":true,"example":409}},"required":["message","error_code"]}},"components/schemas/ApiValidateVerifySmsOtpInput":{"id":"components/schemas/ApiValidateVerifySmsOtpInput","kind":"json-schema","title":"ApiValidateVerifySmsOtpInput","data":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number that the SMS OTP was sent to"},"passcode":{"type":"string","description":"OTP to validate"},"update_primary":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the request to update the user's current verified primary phone number. If the user profile already has a verified primary phone number, it will override it if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or add it as their secondary phone number if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"default":false}},"required":["phone_number","passcode"]}},"components/schemas/ApiVerifySmsResponse":{"id":"components/schemas/ApiVerifySmsResponse","kind":"json-schema","title":"ApiVerifySmsResponse","data":{"type":"object","properties":{"result":{"type":"boolean","readOnly":true,"description":"Boolean value indicating if SMS verification succeeded"}},"required":["result"]}},"components/schemas/EmailVerificationMethod":{"id":"components/schemas/EmailVerificationMethod","kind":"json-schema","title":"EmailVerificationMethod","data":{"type":"string","enum":["otp","link"]}},"components/schemas/EmailContentAttributes":{"id":"components/schemas/EmailContentAttributes","kind":"json-schema","title":"EmailContentAttributes","data":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email"},"primaryColor":{"type":"string","example":"#6981FF","description":"Primary color of the email, specified as a Hex color"},"base64logo":{"type":"string","description":"Base64 encoded image for email logo. Must be raw base64 of a PNG, JPEG, GIF or WebP image, without a data URI prefix, such as 'data:image/png;base64,'. The string length must be less than or equal to 60000 characters."},"headerText":{"type":"string","description":"The header of the email"},"bodyText":{"type":"string","description":"The body of the email"},"linkText":{"type":"string","description":"The text of the link button in the email"},"infoText":{"type":"string","description":"Any extra information in the email"},"footerText":{"type":"string","example":"If you didn't request this email, you can safely ignore it.","description":"The footer of the email"},"senderName":{"type":"string","description":"Name of the sender of the email"}},"required":["subject"]}},"schema_514":{"kind":"json-schema","data":{"type":"string"},"id":"schema_514"}},"exampleStore":{"paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired":{"value":{"message":"Passcode expired","error_code":400,"error_type":"expired_otp"},"key":"OtpExpired","summary":"OtpExpired","id":"paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired"},"paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidEmailOrPasscode":{"value":{"message":"Invalid email or passcode","error_code":400,"error_type":"invalid_otp"},"key":"InvalidEmailOrPasscode","summary":"InvalidEmailOrPasscode","id":"paths/~1v1~1users~1{user_id}~1email~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidEmailOrPasscode"},"paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired":{"value":{"message":"Passcode expired","error_code":400,"error_type":"expired_otp"},"key":"OtpExpired","summary":"OtpExpired","id":"paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/OtpExpired"},"paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidPhoneOrPasscode":{"value":{"message":"Invalid phone number or passcode","error_code":400,"error_type":"invalid_otp"},"key":"InvalidPhoneOrPasscode","summary":"InvalidPhoneOrPasscode","id":"paths/~1v1~1users~1{user_id}~1phone~1verification~1verify/post/responses/400/content/application~1json/examples/InvalidPhoneOrPasscode"}},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/verification.openapi.json?download"},{"url":"/_bundle/openapi/user/verification.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Verification","description":"Verify user data that will enrich their profile"}},"baseSlug":"/openapi/user/verification.openapi","routesMapping":{}}