This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n *
See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage verification.start;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.verification.api.v1.VerificationsStartService;\nimport com.sinch.sdk.domains.verification.models.v1.NumberIdentity;\nimport com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSms;\nimport com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Start {\n\n private static final Logger LOGGER = Logger.getLogger(Start.class.getName());\n\n public static void main(String[] args) {\n\n String applicationKey = Settings.getApplicationKey().orElse(\"MY_APPLICATION_KEY\");\n String applicationSecret = Settings.getApplicationSecret().orElse(\"MY_APPLICATION_SECRET\");\n\n // The phone number you want to verify, in E.164 format (e.g. +46701234567).\n String phoneNumber = \"PHONE_NUMBER\";\n\n Configuration configuration =\n Configuration.builder()\n .setApplicationKey(applicationKey)\n .setApplicationSecret(applicationSecret)\n .build();\n\n SinchClient client = new SinchClient(configuration);\n\n VerificationsStartService verificationsStartService =\n client.verification().v1().verificationStart();\n\n LOGGER.info(String.format(\"Start a verification by SMS onto phone number '%s'\", phoneNumber));\n\n VerificationStartRequestSms request =\n VerificationStartRequestSms.builder()\n .setIdentity(NumberIdentity.valueOf(phoneNumber))\n .build();\n\n VerificationStartResponse response = verificationsStartService.startSms(request);\n\n LOGGER.info(\"Response: \" + response);\n }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n const applicationKey = process.env.SINCH_APPLICATION_KEY ?? 'MY_APPLICATION_KEY';\n const applicationSecret = process.env.SINCH_APPLICATION_SECRET ?? 'MY_APPLICATION_SECRET';\n\n const sinch = new SinchClient({ applicationKey, applicationSecret });\n\n // The phone number you want to verify, in E.164 format (e.g. +46701234567).\n const phoneNumber = 'PHONE_NUMBER';\n\n try {\n const response = await sinch.verification.verifications.startSms({\n startVerificationWithSmsRequestBody: {\n identity: {\n type: 'number',\n endpoint: phoneNumber,\n },\n },\n });\n console.log('✅ Successfully started the verification process via SMS.');\n console.log(JSON.stringify(response, null, 2));\n } catch (err) {\n console.error(`❌ Failed to start a verification process via SMS for the phone number ${phoneNumber}:`);\n console.error(err);\n }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"schemaId":"components/schemas/VerificationStartRequest","exampleIds":["paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestSms","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestFlashCall","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestPhoneCall","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestData","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestWhatsApp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationStartRequest","exampleIds":["paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestSms","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestFlashCall","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestPhoneCall","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestData","paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestWhatsApp"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A success response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/errors/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStartResponse"}},"schemaId":"components/schemas/VerificationStartResponse"}],"pointer":"/paths/~1verification~1v1~1verifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationStartResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStartResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications-start/startverification"}],"panels":[]}]},"httpPath":"/verification/v1/verifications"}],"content":{"contentType":"group","meta":{"name":"Verifications start"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications start","showPageActions":true},{"nodeType":"markdoc","content":"Start new verification requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/verification/v1/verifications","summary":"Start verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verifications-start/startverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Verifications report","link":"/docs/verification/api-reference/verification/verifications-report","routeSlug":"/docs/verification/api-reference/verification/verifications-report","items":[{"label":"Report a verification using Identity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/verification/api-reference/verification/verifications-report/reportverificationbyidentity","routeSlug":"/docs/verification/api-reference/verification/verifications-report/reportverificationbyidentity","metadata":{"seo":{"title":"Report a verification using Identity","description":"Report the received verification code to verify it, using the identity of the user (in most cases, the phone number). For an SMS verification or Phone Call verification, this is the OTP code. For FlashCall, this is the CLI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ReportVerificationByIdentity","name":"Report a verification using Identity","isWebhook":false,"pointer":"/paths/~1verification~1v1~1verifications~1number~1{endpoint}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report a verification using Identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report the received verification code to verify it, using the identity of the user (in most cases, the phone number). For an SMS verification or Phone Call verification, this is the OTP code. For FlashCall, this is the CLI."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"Application","scopes":[],"type":"apiKey","in":"header","paramName":"Authentication","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"endpoint","in":"path","schemaId":"schema_1032","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-compatible phone number."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1verification~1v1~1verifications~1number~1{endpoint}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationReportRequest"}},"schemaId":"components/schemas/VerificationReportRequest","pointer":"/paths/~1verification~1v1~1verifications~1number~1{endpoint}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/verification/v1/verifications/number/{endpoint}","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[{"name":"endpoint","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"Application","type":"apiKey","name":"Authentication","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationReportRequest"}},"responseCodes":["200"],"pointer":"/verification/v1/verifications/number/{endpoint}","href":"verifications-report/reportverificationbyidentity","openApiOperationId":"ReportVerificationByIdentity","summary":"Report a verification using Identity","securityGroups":[{"Basic":[]},{"Application":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n *
This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n *
See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage verification.report;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.verification.api.v1.VerificationsReportService;\nimport com.sinch.sdk.domains.verification.models.v1.NumberIdentity;\nimport com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequestSms;\nimport com.sinch.sdk.domains.verification.models.v1.report.response.VerificationReportResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class ReportByIdentity {\n\n private static final Logger LOGGER = Logger.getLogger(ReportByIdentity.class.getName());\n\n public static void main(String[] args) {\n\n String applicationKey = Settings.getApplicationKey().orElse(\"MY_APPLICATION_KEY\");\n String applicationSecret = Settings.getApplicationSecret().orElse(\"MY_APPLICATION_SECRET\");\n\n // The phone number being verified via SMS.\n String phoneNumber = \"PHONE_NUMBER\";\n // The OTP is the code the user received via SMS as part of the verification process.\n String receivedVerificationCode = \"OTP_CODE\";\n\n Configuration configuration =\n Configuration.builder()\n .setApplicationKey(applicationKey)\n .setApplicationSecret(applicationSecret)\n .build();\n\n SinchClient client = new SinchClient(configuration);\n\n VerificationsReportService verificationsReportService =\n client.verification().v1().verificationReport();\n\n LOGGER.info(String.format(\"Report SMS verification code for phone number '%s'\", phoneNumber));\n\n VerificationReportRequestSms request =\n VerificationReportRequestSms.builder().setCode(receivedVerificationCode).build();\n\n VerificationReportResponse response =\n verificationsReportService.reportSmsByIdentity(\n NumberIdentity.valueOf(phoneNumber), request);\n\n LOGGER.info(\"Response: \" + response);\n }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n const applicationKey = process.env.SINCH_APPLICATION_KEY ?? 'MY_APPLICATION_KEY';\n const applicationSecret = process.env.SINCH_APPLICATION_SECRET ?? 'MY_APPLICATION_SECRET';\n\n // The phone number being verified via SMS.\n const phoneNumber = 'PHONE_NUMBER';\n // The OTP is the code the user received via SMS as part of the verification process.\n const receivedVerificationCode = 'OTP_CODE';\n\n const sinch = new SinchClient({ applicationKey, applicationSecret });\n\n try {\n const response = await sinch.verification.verifications.reportSmsByIdentity({\n endpoint: phoneNumber,\n reportSmsVerificationByIdentityRequestBody: {\n sms: {\n code: receivedVerificationCode,\n },\n },\n });\n console.log('✅ Successfully reported the OTP for the verification process via SMS.');\n console.log(JSON.stringify(response, null, 2));\n } catch (err) {\n console.error(`❌ Failed to report the OTP for the verification process via SMS for the phone number ${phoneNumber}:`);\n console.error(err);\n }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"schemaId":"components/schemas/VerificationReportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationReportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A success response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/errors/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationReportResponse"}},"schemaId":"components/schemas/VerificationReportResponse"}],"pointer":"/paths/~1verification~1v1~1verifications~1number~1{endpoint}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationReportResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications-report/reportverificationbyidentity"}],"panels":[]}]},"httpPath":"/verification/v1/verifications/number/{endpoint}"},{"label":"Report a verification with ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/verification/api-reference/verification/verifications-report/reportverificationbyid","routeSlug":"/docs/verification/api-reference/verification/verifications-report/reportverificationbyid","metadata":{"seo":{"title":"Report a verification with ID","description":"Report the received verification code to verify it, using the Verification ID of the Verification request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ReportVerificationById","name":"Report a verification with ID","isWebhook":false,"pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report a verification with ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report the received verification code to verify it, using the Verification ID of the Verification request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"Application","scopes":[],"type":"apiKey","in":"header","paramName":"Authentication","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1032","required":true}],"pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationReportRequest"}},"schemaId":"components/schemas/VerificationReportRequest","pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/verification/v1/verifications/id/{id}","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"Application","type":"apiKey","name":"Authentication","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationReportRequest"}},"responseCodes":["200"],"pointer":"/verification/v1/verifications/id/{id}","href":"verifications-report/reportverificationbyid","openApiOperationId":"ReportVerificationById","summary":"Report a verification with ID","securityGroups":[{"Basic":[]},{"Application":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n *
This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n *
See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage verification.report;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.verification.api.v1.VerificationsReportService;\nimport com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequestSms;\nimport com.sinch.sdk.domains.verification.models.v1.report.response.VerificationReportResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class ReportById {\n\n private static final Logger LOGGER = Logger.getLogger(ReportById.class.getName());\n\n public static void main(String[] args) {\n\n String applicationKey = Settings.getApplicationKey().orElse(\"MY_APPLICATION_KEY\");\n String applicationSecret = Settings.getApplicationSecret().orElse(\"MY_APPLICATION_SECRET\");\n\n // The id you received back from the API call when starting verification by SMS\n String verificationId = \"VERIFICATION_ID\";\n // The OTP is the code the user received via SMS as part of the verification process.\n String receivedVerificationCode = \"OTP_CODE\";\n\n Configuration configuration =\n Configuration.builder()\n .setApplicationKey(applicationKey)\n .setApplicationSecret(applicationSecret)\n .build();\n\n SinchClient client = new SinchClient(configuration);\n\n VerificationsReportService verificationsReportService =\n client.verification().v1().verificationReport();\n\n LOGGER.info(\n String.format(\"Report SMS verification code for verification ID '%s'\", verificationId));\n\n VerificationReportRequestSms request =\n VerificationReportRequestSms.builder().setCode(receivedVerificationCode).build();\n\n VerificationReportResponse response =\n verificationsReportService.reportSmsById(verificationId, request);\n\n LOGGER.info(\"Response: \" + response);\n }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n const applicationKey = process.env.SINCH_APPLICATION_KEY ?? 'MY_APPLICATION_KEY';\n const applicationSecret = process.env.SINCH_APPLICATION_SECRET ?? 'MY_APPLICATION_SECRET';\n\n // The id you received back from the API call when starting the SMS verification.\n const verificationId = 'VERIFICATION_ID';\n // The OTP is the code the user received via SMS as part of the verification process.\n const receivedVerificationCode = 'OTP_CODE';\n\n const sinch = new SinchClient({ applicationKey, applicationSecret });\n\n try {\n const response = await sinch.verification.verifications.reportSmsById({\n id: verificationId,\n reportSmsVerificationByIdRequestBody: {\n sms: {\n code: receivedVerificationCode,\n },\n },\n });\n console.log('✅ Successfully reported the OTP for the verification process via SMS.');\n console.log(JSON.stringify(response, null, 2));\n } catch (err) {\n console.error(`❌ Failed to report the OTP for the verification process via SMS with ID ${verificationId}:`);\n console.error(err);\n }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"schemaId":"components/schemas/VerificationReportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationReportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A success response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/errors/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationReportResponse"}},"schemaId":"components/schemas/VerificationReportResponse"}],"pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationReportResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications-report/reportverificationbyid"}],"panels":[]}]},"httpPath":"/verification/v1/verifications/id/{id}"}],"content":{"contentType":"group","meta":{"name":"Verifications report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications report","showPageActions":true},{"nodeType":"markdoc","content":"Report on existing verification requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/verification/v1/verifications/number/{endpoint}","summary":"Report a verification using Identity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/verifications-report/reportverificationbyidentity","deprecated":false},{"title":"/verification/v1/verifications/id/{id}","summary":"Report a verification with ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/verifications-report/reportverificationbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Verifications status","link":"/docs/verification/api-reference/verification/verification-status","routeSlug":"/docs/verification/api-reference/verification/verification-status","items":[{"label":"Get verification by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/verification/api-reference/verification/verification-status/verificationstatusbyid","routeSlug":"/docs/verification/api-reference/verification/verification-status/verificationstatusbyid","metadata":{"seo":{"title":"Get verification by ID","description":"Queries the verification result by sending the verification ID. With this query you can get the result of a verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerificationStatusById","name":"Get verification by ID","isWebhook":false,"pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verification by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the verification result by sending the verification ID. With this query you can get the result of a verification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"Application","scopes":[],"type":"apiKey","in":"header","paramName":"Authentication","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1032","description":"The ID of the verification.","required":true}],"pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verification/v1/verifications/id/{id}","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"Application","type":"apiKey","name":"Authentication","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/verification/v1/verifications/id/{id}","href":"verification-status/verificationstatusbyid","openApiOperationId":"VerificationStatusById","summary":"Get verification by ID","securityGroups":[{"Basic":[]},{"Application":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n *
This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n *
See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage verification.status;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.verification.api.v1.VerificationsStatusService;\nimport com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class GetById {\n\n private static final Logger LOGGER = Logger.getLogger(GetById.class.getName());\n\n public static void main(String[] args) {\n\n String applicationKey = Settings.getApplicationKey().orElse(\"MY_APPLICATION_KEY\");\n String applicationSecret = Settings.getApplicationSecret().orElse(\"MY_APPLICATION_SECRET\");\n\n // The id you received back from the API call when starting verification\n String verificationId = \"VERIFICATION_ID\";\n\n Configuration configuration =\n Configuration.builder()\n .setApplicationKey(applicationKey)\n .setApplicationSecret(applicationSecret)\n .build();\n\n SinchClient client = new SinchClient(configuration);\n\n VerificationsStatusService verificationsStatusService =\n client.verification().v1().verificationStatus();\n\n LOGGER.info(String.format(\"Verification status for verification ID '%s'\", verificationId));\n\n VerificationStatusResponse response = verificationsStatusService.getById(verificationId);\n\n LOGGER.info(\"Response: \" + response);\n }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n const applicationKey = process.env.SINCH_APPLICATION_KEY ?? 'MY_APPLICATION_KEY';\n const applicationSecret = process.env.SINCH_APPLICATION_SECRET ?? 'MY_APPLICATION_SECRET';\n\n // The id you received back from the API call when starting the verification.\n const verificationId = 'VERIFICATION_ID';\n\n const sinch = new SinchClient({ applicationKey, applicationSecret });\n\n try {\n const response = await sinch.verification.verificationStatus.getById({\n id: verificationId,\n });\n console.log('✅ Successfully retrieved Verification.');\n console.log(JSON.stringify(response, null, 2));\n } catch (err) {\n console.error(`❌ Failed to retrieve the Verification with ID ${verificationId}:`);\n console.error(err);\n }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A success response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/errors/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStatusResponse"}},"schemaId":"components/schemas/VerificationStatusResponse"}],"pointer":"/paths/~1verification~1v1~1verifications~1id~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStatusResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-status/verificationstatusbyid"}],"panels":[]}]},"httpPath":"/verification/v1/verifications/id/{id}"},{"label":"Get verification by Identity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/verification/api-reference/verification/verification-status/verificationstatusbyidentity","routeSlug":"/docs/verification/api-reference/verification/verification-status/verificationstatusbyidentity","metadata":{"seo":{"title":"Get verification by Identity","description":"Queries the verification result by sending the verification Identity (usually a phone number) and its method. With this query you can get the result of a verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerificationStatusByIdentity","name":"Get verification by Identity","isWebhook":false,"pointer":"/paths/~1verification~1v1~1verifications~1{method}~1number~1{endpoint}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verification by Identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the verification result by sending the verification Identity (usually a phone number) and its method. With this query you can get the result of a verification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"Application","scopes":[],"type":"apiKey","in":"header","paramName":"Authentication","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"endpoint","in":"path","schemaId":"schema_1032","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-compatible phone number."},"children":[]}]}]}],"required":true},{"name":"method","in":"path","schemaId":"schema_1032","description":"The method of the verification.","required":true}],"pointer":"/paths/~1verification~1v1~1verifications~1{method}~1number~1{endpoint}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verification/v1/verifications/{method}/number/{endpoint}","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[{"name":"endpoint","in":"path","required":true,"schemaId":"schema_1032"},{"name":"method","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"Application","type":"apiKey","name":"Authentication","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/verification/v1/verifications/{method}/number/{endpoint}","href":"verification-status/verificationstatusbyidentity","openApiOperationId":"VerificationStatusByIdentity","summary":"Get verification by Identity","securityGroups":[{"Basic":[]},{"Application":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n *
This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n *
See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage verification.status;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.verification.api.v1.VerificationsStatusService;\nimport com.sinch.sdk.domains.verification.models.v1.NumberIdentity;\nimport com.sinch.sdk.domains.verification.models.v1.VerificationMethod;\nimport com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class GetByIdentity {\n\n private static final Logger LOGGER = Logger.getLogger(GetByIdentity.class.getName());\n\n public static void main(String[] args) {\n\n String applicationKey = Settings.getApplicationKey().orElse(\"MY_APPLICATION_KEY\");\n String applicationSecret = Settings.getApplicationSecret().orElse(\"MY_APPLICATION_SECRET\");\n\n // The phone number you are verifying, in E.164 format (e.g. +46701234567).\n // This should be the same number you used when starting the verification.\n String phoneNumber = \"PHONE_NUMBER\";\n // The verification method you used when starting the verification.\n VerificationMethod verificationMethod = VerificationMethod.SMS;\n\n Configuration configuration =\n Configuration.builder()\n .setApplicationKey(applicationKey)\n .setApplicationSecret(applicationSecret)\n .build();\n\n SinchClient client = new SinchClient(configuration);\n\n VerificationsStatusService verificationsStatusService =\n client.verification().v1().verificationStatus();\n\n LOGGER.info(String.format(\"Verification status for phone number '%s'\", phoneNumber));\n\n NumberIdentity identity = NumberIdentity.valueOf(phoneNumber);\n\n VerificationStatusResponse response =\n verificationsStatusService.getByIdentity(identity, verificationMethod);\n\n LOGGER.info(\"Response: \" + response);\n }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n const applicationKey = process.env.SINCH_APPLICATION_KEY ?? 'MY_APPLICATION_KEY';\n const applicationSecret = process.env.SINCH_APPLICATION_SECRET ?? 'MY_APPLICATION_SECRET';\n\n // The phone number you are verifying, in E.164 format (e.g. +46701234567).\n // This should be the same number you used when starting the verification.\n const phoneNumber = 'PHONE_NUMBER';\n // Possible values: 'sms', 'flashcall', 'phonecall', 'whatsapp'\n const verificationMethod = 'sms';\n\n const sinch = new SinchClient({ applicationKey, applicationSecret });\n\n try {\n const response = await sinch.verification.verificationStatus.getByIdentity({\n endpoint: phoneNumber,\n method: verificationMethod,\n });\n console.log('✅ Successfully retrieved Verification.');\n console.log(JSON.stringify(response, null, 2));\n } catch (err) {\n console.error(`❌ Failed to retrieve the Verification for the phone number ${phoneNumber}:`);\n console.error(err);\n }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A success response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/errors/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStatusResponse"}},"schemaId":"components/schemas/VerificationStatusResponse"}],"pointer":"/paths/~1verification~1v1~1verifications~1{method}~1number~1{endpoint}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStatusResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-status/verificationstatusbyidentity"}],"panels":[]}]},"httpPath":"/verification/v1/verifications/{method}/number/{endpoint}"},{"label":"Get verification by Reference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/verification/api-reference/verification/verification-status/verificationstatusbyreference","routeSlug":"/docs/verification/api-reference/verification/verification-status/verificationstatusbyreference","metadata":{"seo":{"title":"Get verification by Reference","description":"Queries the verification result by sending the verification Reference. With this query you can get the result of a verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerificationStatusByReference","name":"Get verification by Reference","isWebhook":false,"pointer":"/paths/~1verification~1v1~1verifications~1reference~1{reference}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get verification by Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queries the verification result by sending the verification Reference. With this query you can get the result of a verification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"Application","scopes":[],"type":"apiKey","in":"header","paramName":"Authentication","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reference","in":"path","schemaId":"schema_1032","description":"The custom reference of the verification.","required":true}],"pointer":"/paths/~1verification~1v1~1verifications~1reference~1{reference}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verification/v1/verifications/reference/{reference}","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[{"name":"reference","in":"path","required":true,"schemaId":"schema_1032"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"Application","type":"apiKey","name":"Authentication","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/verification/v1/verifications/reference/{reference}","href":"verification-status/verificationstatusbyreference","openApiOperationId":"VerificationStatusByReference","summary":"Get verification by Reference","securityGroups":[{"Basic":[]},{"Application":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n *
This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n *
See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage verification.status;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.verification.api.v1.VerificationsStatusService;\nimport com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class GetByReference {\n\n private static final Logger LOGGER = Logger.getLogger(GetByReference.class.getName());\n\n public static void main(String[] args) {\n\n String applicationKey = Settings.getApplicationKey().orElse(\"MY_APPLICATION_KEY\");\n String applicationSecret = Settings.getApplicationSecret().orElse(\"MY_APPLICATION_SECRET\");\n\n // The reference you defined when starting the verification process.\n String verificationReference = \"VERIFICATION_REFERENCE\";\n\n Configuration configuration =\n Configuration.builder()\n .setApplicationKey(applicationKey)\n .setApplicationSecret(applicationSecret)\n .build();\n\n SinchClient client = new SinchClient(configuration);\n\n VerificationsStatusService verificationsStatusService =\n client.verification().v1().verificationStatus();\n\n LOGGER.info(\n String.format(\n \"Verification status for verification with reference '%s'\", verificationReference));\n\n VerificationStatusResponse response =\n verificationsStatusService.getByReference(verificationReference);\n\n LOGGER.info(\"Response: \" + response);\n }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n const applicationKey = process.env.SINCH_APPLICATION_KEY ?? 'MY_APPLICATION_KEY';\n const applicationSecret = process.env.SINCH_APPLICATION_SECRET ?? 'MY_APPLICATION_SECRET';\n\n // The reference you defined when starting the verification process.\n const verificationReference = 'VERIFICATION_REFERENCE';\n\n const sinch = new SinchClient({ applicationKey, applicationSecret });\n\n try{\n const response = await sinch.verification.verificationStatus.getByReference({\n reference: verificationReference,\n });\n console.log('✅ Successfully retrieved Verification.');\n console.log(JSON.stringify(response, null, 2));\n } catch (err) {\n console.error(`❌ Failed to retrieve the Verification with reference ${verificationReference}:`);\n console.error(err);\n }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A success response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/errors/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStatusResponse"}},"schemaId":"components/schemas/VerificationStatusResponse"}],"pointer":"/paths/~1verification~1v1~1verifications~1reference~1{reference}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationStatusResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-status/verificationstatusbyreference"}],"panels":[]}]},"httpPath":"/verification/v1/verifications/reference/{reference}"}],"content":{"contentType":"group","meta":{"name":"Verification status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications status","showPageActions":true},{"nodeType":"markdoc","content":"Get the status of specific verification requests in the verification process. Returns the status of pending and completed verifications. You can retrieve the status of verification requests by using the ID of the request, the phone number of the user being verified, or a custom reference string."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/verification/v1/verifications/id/{id}","summary":"Get verification by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-status/verificationstatusbyid","deprecated":false},{"title":"/verification/v1/verifications/{method}/number/{endpoint}","summary":"Get verification by Identity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-status/verificationstatusbyidentity","deprecated":false},{"title":"/verification/v1/verifications/reference/{reference}","summary":"Get verification by Reference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-status/verificationstatusbyreference","deprecated":false}]}]}]}]}},{"type":"group","label":"Verifications callbacks","link":"/docs/verification/api-reference/verification/verification-callbacks","routeSlug":"/docs/verification/api-reference/verification/verification-callbacks","items":[{"label":"Verification Request Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/verification/api-reference/verification/verification-callbacks/verificationrequestevent","routeSlug":"/docs/verification/api-reference/verification/verification-callbacks/verificationrequestevent","metadata":{"seo":{"title":"Verification Request Event","description":"This callback event is a POST request to the specified verification callback URL and is triggered when a new verification request is made from the SDK client or the Verification Request API. This callback event is only triggered when a verification callback URL is specified in your dashboard."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerificationRequestEvent","name":"Verification Request Event","isWebhook":true,"pointer":"/paths/VerificationRequestEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verification Request Event","isWebhook":true,"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":"This callback event is a POST request to the specified verification callback URL and is triggered when a new verification request is made from the SDK client or the Verification Request API. This callback event is only triggered when a verification callback URL is specified in your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/verification/apps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationRequestEvent"}},"schemaId":"components/schemas/VerificationRequestEvent","pointer":"/paths/VerificationRequestEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"VerificationRequestEvent","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationRequestEvent"}},"responseCodes":["200"],"pointer":"VerificationRequestEvent","href":"verification-callbacks/verificationrequestevent","openApiOperationId":"VerificationRequestEvent","summary":"Verification Request Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"schemaId":"components/schemas/VerificationRequestEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationRequestEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationRequestEventResponse"}},"schemaId":"components/schemas/VerificationRequestEventResponse"}],"pointer":"/paths/VerificationRequestEvent/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationRequestEventResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationRequestEventResponse"}}}],"isEvent":true,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-callbacks/verificationrequestevent"}],"panels":[]}]},"httpPath":"VerificationRequestEvent"},{"label":"Verification Result Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/verification/api-reference/verification/verification-callbacks/verificationresultevent","routeSlug":"/docs/verification/api-reference/verification/verification-callbacks/verificationresultevent","metadata":{"seo":{"title":"Verification Result Event","description":"This callback event is a POST request to the specified verification callback URL and triggered when a verification has been completed and the result is known. It's used to report the verification result to the developer's backend application. This callback event is only triggered when the verification callback URL is specified in your dashboard."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerificationResultEvent","name":"Verification Result Event","isWebhook":true,"pointer":"/paths/VerificationResultEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verification Result Event","isWebhook":true,"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":"This callback event is a POST request to the specified verification callback URL and triggered when a verification has been completed and the result is known. It's used to report the verification result to the developer's backend application. This callback event is only triggered when the verification callback URL is specified in your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/verification/apps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationResultEvent"}},"schemaId":"components/schemas/VerificationResultEvent","pointer":"/paths/VerificationResultEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"VerificationResultEvent","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationResultEvent"}},"responseCodes":["200"],"pointer":"VerificationResultEvent","href":"verification-callbacks/verificationresultevent","openApiOperationId":"VerificationResultEvent","summary":"Verification Result Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"schemaId":"components/schemas/VerificationResultEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationResultEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must return an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]}],"mediaType":"schema","mediaTypes":["schema"],"mediaTypeContent":{"schema":{}}}],"pointer":"/paths/VerificationResultEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-callbacks/verificationresultevent"}],"panels":[]}]},"httpPath":"VerificationResultEvent"},{"label":"SMS Delivered Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/verification/api-reference/verification/verification-callbacks/smsdeliveredevent","routeSlug":"/docs/verification/api-reference/verification/verification-callbacks/smsdeliveredevent","metadata":{"seo":{"title":"SMS Delivered Event","description":"This callback event is a POST request to the specified verification callback URL and is triggered when an SMS delivery receipt is received. It is used to report the final delivery status of the verification SMS. This callback event is only triggered when a verification callback URL is specified in your dashboard."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SmsDeliveredEvent","name":"SMS Delivered Event","isWebhook":true,"pointer":"/paths/SmsDeliveredEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SMS Delivered Event","isWebhook":true,"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":"This callback event is a POST request to the specified verification callback URL and is triggered when an SMS delivery receipt is received. It is used to report the final delivery status of the verification SMS. This callback event is only triggered when a verification callback URL is specified in your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/verification/apps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationSmsDeliveredEvent"}},"schemaId":"components/schemas/VerificationSmsDeliveredEvent","pointer":"/paths/SmsDeliveredEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"SmsDeliveredEvent","servers":[{"url":"https://verification.api.sinch.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/VerificationSmsDeliveredEvent"}},"responseCodes":["200"],"pointer":"SmsDeliveredEvent","href":"verification-callbacks/smsdeliveredevent","openApiOperationId":"SmsDeliveredEvent","summary":"SMS Delivered Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://verification.api.sinch.com"}],"schemaId":"components/schemas/VerificationSmsDeliveredEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerificationSmsDeliveredEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must return an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]}],"mediaType":"schema","mediaTypes":["schema"],"mediaTypeContent":{"schema":{}}}],"pointer":"/paths/SmsDeliveredEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-callbacks/smsdeliveredevent"}],"panels":[]}]},"httpPath":"SmsDeliveredEvent"}],"content":{"contentType":"group","meta":{"name":"Verification callbacks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications callbacks","showPageActions":true},{"nodeType":"markdoc","content":"Callback events are used to authorize and manage your verification requests and return verification results."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"VerificationRequestEvent","summary":"Verification Request Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification-callbacks/verificationrequestevent","deprecated":false},{"title":"VerificationResultEvent","summary":"Verification Result Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification-callbacks/verificationresultevent","deprecated":false},{"title":"SmsDeliveredEvent","summary":"SMS Delivered Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification-callbacks/smsdeliveredevent","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"status":{"type":"string","description":"A summary of the HTTP error code and error type.","example":"404 Not Found"},"errorCode":{"type":"string","description":"The HTTP error code.","example":"40400"},"message":{"type":"string","description":"A simple description of the cause of the error.","example":"Call not found"},"reference":{"type":"string","description":"If applicable, a reference ID for support to use with diagnosing the error.","example":"a2028355-5164-41b6-aae9-2b8a546e0784"}}}},"components/schemas/VerificationEvent":{"id":"components/schemas/VerificationEvent","kind":"json-schema","title":"VerificationEvent","data":{"oneOf":[{"$ref":"#/components/schemas/VerificationRequestEvent"},{"$ref":"#/components/schemas/VerificationResultEvent"},{"$ref":"#/components/schemas/VerificationSmsDeliveredEvent"}],"discriminator":{"propertyName":"event","mapping":{"VerificationRequestEvent":"#/components/schemas/VerificationRequestEvent","VerificationResultEvent":"#/components/schemas/VerificationResultEvent","VerificationSmsDeliveredEvent":"#/components/schemas/VerificationSmsDeliveredEvent"}}}},"components/schemas/VerificationEventReference":{"id":"components/schemas/VerificationEventReference","kind":"json-schema","title":"VerificationEventReference","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to pass your own reference in the request for tracking purposes. Must be a unique value for each started verification request. The value must be encodable in the URL path segment. This value is passed to all events and returned from the status and report endpoints. The reference can be used to check the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/verification/verification-status/verificationstatusbyreference"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status of verifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", like with ID or identity."},"children":[]}]}]}]}},"components/schemas/VerificationEventCustom":{"id":"components/schemas/VerificationEventCustom","kind":"json-schema","title":"VerificationEventCustom","data":{"type":"string","description":"Can be used to pass custom data in the request. Will be passed to all events. Max length 4096 characters, can be arbitrary text data."}},"components/schemas/VerificationEventType":{"id":"components/schemas/VerificationEventType","kind":"json-schema","title":"VerificationEventType","data":{"type":"string","description":"The type of the event.","x-enumDescriptions":{"VerificationRequestEvent":"Define a request event type","VerificationResultEvent":"Define a result event type","VerificationSmsDeliveredEvent":"Define an SMS delivered result event type"},"enum":["VerificationRequestEvent","VerificationResultEvent","VerificationSmsDeliveredEvent"]}},"components/schemas/VerificationEventBase":{"id":"components/schemas/VerificationEventBase","kind":"json-schema","title":"VerificationEventBase","data":{"required":["id","event","method","identity"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the verification request.","example":"1234567890"},"event":{"$ref":"#/components/schemas/VerificationEventType"},"method":{"$ref":"#/components/schemas/VerificationMethodReport"},"identity":{"$ref":"#/components/schemas/Identity"},"reference":{"$ref":"#/components/schemas/VerificationEventReference"},"custom":{"$ref":"#/components/schemas/VerificationEventCustom"}}}},"components/schemas/VerificationRequestEvent":{"id":"components/schemas/VerificationRequestEvent","kind":"json-schema","title":"VerificationRequestEvent","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/VerificationEventBase"},{"type":"object","properties":{"event":{"type":"string","description":"The type of the event.","example":"VerificationRequestEvent","x-enumDescriptions":{"VerificationRequestEvent":"Event received onto verification request"},"enum":["VerificationRequestEvent"]},"price":{"$ref":"#/components/schemas/Price"},"acceptLanguage":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to set or override if provided in the API request, the SMS verification content language. Only used with the SMS verification method. The content language specified in the API request or in the callback can be overridden by carrier provider specific templates, due to compliance and legal requirements, such as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/SMS/Sinch-US-Short-Code-Onboarding-Overview/ta-p/7085"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US shortcode requirements (pdf)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"deprecated":true,"items":{"type":"string","example":"es-ES"}}}}]}},"components/schemas/VerificationRequestEventResponse":{"id":"components/schemas/VerificationRequestEventResponse","kind":"json-schema","title":"VerificationRequestEventResponse","data":{"oneOf":[{"$ref":"#/components/schemas/VerificationRequestEventResponseSms"},{"$ref":"#/components/schemas/VerificationRequestEventResponseFlashCall"},{"$ref":"#/components/schemas/VerificationRequestEventResponsePhoneCall"},{"$ref":"#/components/schemas/VerificationRequestEventResponseWhatsApp"}]}},"components/schemas/VerificationEventResponseAction":{"id":"components/schemas/VerificationEventResponseAction","kind":"json-schema","title":"VerificationEventResponseAction","data":{"type":"string","description":"Determines whether the verification can be executed.","x-enumDescriptions":{"allow":"Verification allowed","deny":"Verification denied"},"enum":["allow","deny"],"example":"allow"}},"components/schemas/StatusCallResult":{"id":"components/schemas/StatusCallResult","kind":"json-schema","title":"StatusCallResult","data":{"type":"string","description":"The type of the call result.","x-enumDescriptions":{"ANSWERED":"Call answered","CANCEL":"Call canceled","COMPLETED":"Call completed","NO_ANSWER":"No answer to call","BUSY":"Busy Call","FAILED":"Call failed"},"enum":["ANSWERED","CANCEL","COMPLETED","NO_ANSWER","BUSY","FAILED"]}},"components/schemas/VerificationRequestEventResponseBase":{"id":"components/schemas/VerificationRequestEventResponseBase","kind":"json-schema","title":"VerificationRequestEventResponseBase","data":{"type":"object","required":["action"],"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/VerificationEventResponseAction"}}}},"components/schemas/VerificationRequestEventResponseSms":{"id":"components/schemas/VerificationRequestEventResponseSms","kind":"json-schema","title":"SMS Request Event Response","data":{"title":"SMS Request Event Response","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationRequestEventResponseBase"},{"type":"object","properties":{"sms":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"The SMS OTP code that should be used. By default, the Sinch dashboard will automatically generate OTP codes for SMS verification. If you want to set your own OTP, you can specify it in the response to the Verification Request Event.","example":"12345"},"codeType":{"$ref":"#/components/schemas/SmsCodeType"},"expiry":{"$ref":"#/components/schemas/SmsExpiry"},"acceptLanguage":{"type":"array","description":"The SMS verification content language. Set in the verification request.","items":{"type":"string","example":"es-ES"}}}}}}],"example":{"summary":"SMS OTP","value":{"action":"allow","sms":{"code":"3688","acceptLanguage":["en-US"]}}}}},"components/schemas/VerificationRequestEventResponseFlashCall":{"id":"components/schemas/VerificationRequestEventResponseFlashCall","kind":"json-schema","title":"Flash Call Request Event Response","data":{"title":"Flash Call Request Event Response","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationRequestEventResponseBase"},{"type":"object","properties":{"flashCall":{"type":"object","additionalProperties":true,"properties":{"cli":{"type":"string","description":"The phone number that will be displayed to the user when the flash call is received on the user's phone. By default, the Sinch dashboard will randomly select the CLI that will be displayed during a phone call from a pool of numbers. If you want to set your own CLI, you can specify it in the response to the Verification Request Event."},"dialTimeout":{"$ref":"#/components/schemas/FlashCallDialTimeout"},"interceptionTimeout":{"$ref":"#/components/schemas/FlashCallInterceptionTimeout"}}}}}],"example":{"summary":"Flash Call","value":{"action":"allow","flashCall":{"cli":"+46700000000","dialTimeout":10}}}}},"components/schemas/VerificationRequestEventResponsePhoneCall":{"id":"components/schemas/VerificationRequestEventResponsePhoneCall","kind":"json-schema","title":"Phone Call Request Event Response","data":{"title":"Phone Call Request Event Response","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationRequestEventResponseBase"},{"type":"object","properties":{"callout":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"The Phone Call OTP code that should be entered by the user. Sinch servers automatically generate OTP codes for Phone Call verification. If you want to set your own code, you can specify it in the response to the Verification Request Event."},"speech":{"$ref":"#/components/schemas/PhoneCallSpeech"}}}}}],"example":{"summary":"Phone Call","value":{"action":"allow","callout":{"code":"1234","speech":{"locale":"en_US"}}}}}},"components/schemas/VerificationRequestEventResponseWhatsApp":{"id":"components/schemas/VerificationRequestEventResponseWhatsApp","kind":"json-schema","title":"WhatsApp Request Event Response","data":{"title":"WhatsApp Request Event Response","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationRequestEventResponseBase"},{"type":"object","properties":{"whatsapp":{"type":"object","additionalProperties":true,"properties":{"codeType":{"$ref":"#/components/schemas/WhatsAppCodeType"},"acceptLanguage":{"type":"array","description":"The WhatsApp verification content language. Set in the verification request.","items":{"type":"string","example":"es-ES"}}}}}}],"example":{"summary":"WhatsApp OTP","value":{"action":"allow","whatsapp":{"acceptLanguage":["en-US"]}}}}},"components/schemas/Source":{"id":"components/schemas/Source","kind":"json-schema","title":"Source","data":{"type":"string","description":"With the SMS verification method, a user's phone number is verified by sending an SMS containing an OTP code that must be manually returned. If you are are using an Android handset, you could instead intercept the SMS message delivery and capture the OTP code automatically.","x-enumDescriptions":{"intercepted":"OTP verification was performed automatically","manual":"OTP verification was manually performed"},"enum":["intercepted","manual"],"example":"intercepted"}},"components/schemas/VerificationResultEvent":{"id":"components/schemas/VerificationResultEvent","kind":"json-schema","title":"VerificationResultEvent","data":{"required":["status"],"type":"object","allOf":[{"$ref":"#/components/schemas/VerificationEventBase"},{"type":"object","properties":{"event":{"type":"string","description":"The type of the event.","example":"VerificationResultEvent","x-enumDescriptions":{"VerificationResultEvent":"Notification Event received onto verification result"},"enum":["VerificationResultEvent"]},"status":{"$ref":"#/components/schemas/VerificationStatus"},"reason":{"$ref":"#/components/schemas/VerificationStatusReason"},"source":{"$ref":"#/components/schemas/Source"}}}]}},"components/schemas/VerificationSmsDeliveredEvent":{"id":"components/schemas/VerificationSmsDeliveredEvent","kind":"json-schema","title":"VerificationSmsDeliveredEvent","data":{"required":["smsResult"],"type":"object","allOf":[{"$ref":"#/components/schemas/VerificationEventBase"},{"type":"object","properties":{"event":{"type":"string","description":"The type of the event.","example":"VerificationSmsDeliveredEvent","x-enumDescriptions":{"VerificationSmsDeliveredEvent":"Event received onto verification request"},"enum":["VerificationSmsDeliveredEvent"]},"smsResult":{"type":"string","description":"The result of the SMS delivery. Possible values can be extended in the future.","x-enumDescriptions":{"Successful":"SMS delivered to user successfully","Failed":"SMS delivery to user failed"},"enum":["Successful","Failed"],"example":"Successful"}}}]}},"components/schemas/VerificationStartResponseBase":{"id":"components/schemas/VerificationStartResponseBase","kind":"json-schema","title":"VerificationStartResponseBase","data":{"type":"object","additionalProperties":false,"required":["id","method"],"properties":{"id":{"type":"string","description":"Verification identifier used to query for status.","example":"1234567890"},"method":{"$ref":"#/components/schemas/VerificationMethodStart"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Links"}}}}},"components/schemas/VerificationStartResponseSms":{"id":"components/schemas/VerificationStartResponseSms","kind":"json-schema","title":"SMS Response","data":{"title":"SMS Response","type":"object","allOf":[{"$ref":"#/components/schemas/VerificationStartResponseBase"},{"type":"object","properties":{"sms":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the SMS to be expected and intercepted."},"children":[]}]}]}],"additionalProperties":true,"properties":{"template":{"type":"string","description":"The expected template for the SMS response.","example":"Your verification code is {{CODE}}"},"interceptionTimeout":{"type":"integer","format":"int32","description":"The amount of time in seconds that the client should wait for the SMS.","example":32},"codeType":{"$ref":"#/components/schemas/SmsCodeType"}}}}}]}},"components/schemas/VerificationStartResponseFlashCall":{"id":"components/schemas/VerificationStartResponseFlashCall","kind":"json-schema","title":"Flash Call Response","data":{"title":"Flash Call Response","type":"object","allOf":[{"$ref":"#/components/schemas/VerificationStartResponseBase"},{"type":"object","properties":{"flashCall":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cliFilter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interceptionTimeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]}]}]}],"additionalProperties":true,"required":["cliFilter","interceptionTimeout"],"type":"object","properties":{"cliFilter":{"type":"string","description":"Filter that should be applied for incoming calls to intercept the flash call.","example":"(.*)70123(.*)"},"interceptionTimeout":{"type":"integer","description":"Amount of seconds client should wait for the flash call.","format":"int32","example":60},"reportTimeout":{"type":"integer","description":"The time in seconds allowed for reporting the code after which the verification will expire.","example":120},"denyCallAfter":{"type":"integer","description":"Used by the mobile SDKs, this setting makes the handset deny the flash call after the set time in seconds.","example":120}}}}}]}},"components/schemas/VerificationStartResponsePhoneCall":{"id":"components/schemas/VerificationStartResponsePhoneCall","kind":"json-schema","title":"Phone Call Response","data":{"title":"Phone Call Response","type":"object","allOf":[{"$ref":"#/components/schemas/VerificationStartResponseBase"}]}},"components/schemas/VerificationStartResponseWhatsApp":{"id":"components/schemas/VerificationStartResponseWhatsApp","kind":"json-schema","title":"WhatsApp","data":{"title":"WhatsApp","type":"object","allOf":[{"$ref":"#/components/schemas/VerificationStartResponseBase"},{"type":"object","properties":{"whatsapp":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"additionalProperties":true,"properties":{"codeType":{"$ref":"#/components/schemas/WhatsAppCodeType"}}}}}]}},"components/schemas/VerificationStartResponseData":{"id":"components/schemas/VerificationStartResponseData","kind":"json-schema","title":"Data Response","data":{"title":"Data Response","type":"object","required":["id","seamless"],"allOf":[{"$ref":"#/components/schemas/VerificationStartResponseBase"},{"type":"object","properties":{"seamless":{"description":"The response contains the target URI.","type":"object","properties":{"targetUri":{"type":"string","description":"The target URI.","example":"https://targetURI.com"}}}}}]}},"components/schemas/VerificationStartResponse":{"id":"components/schemas/VerificationStartResponse","kind":"json-schema","title":"VerificationStartResponse","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/VerificationStartResponseSms"},{"$ref":"#/components/schemas/VerificationStartResponseFlashCall"},{"$ref":"#/components/schemas/VerificationStartResponsePhoneCall"},{"$ref":"#/components/schemas/VerificationStartResponseData"},{"$ref":"#/components/schemas/VerificationStartResponseWhatsApp"}],"discriminator":{"propertyName":"method","mapping":{"sms":"#/components/schemas/VerificationStartResponseSms","flashcall":"#/components/schemas/VerificationStartResponseFlashCall","callout":"#/components/schemas/VerificationStartResponsePhoneCall","seamless":"#/components/schemas/VerificationStartResponseData","whatsapp":"#/components/schemas/VerificationStartResponseWhatsApp"}}}},"components/schemas/VerificationMethodStart":{"id":"components/schemas/VerificationMethodStart","kind":"json-schema","title":"VerificationMethodStart","data":{"type":"string","description":"The type of the verification request.","example":"sms","x-enumDescriptions":{"sms":"Verification by SMS message with an OTP code.","flashcall":"Verification by placing a flashVerificationResultEvent call (missed call) and detecting the incoming calling number (CLI).","callout":"Verification by placing a PSTN call to the user's phone and playing an announcement, asking the user to press a particular digit to verify the phone number.","seamless":"Data verification. Verification by accessing internal infrastructure of mobile carriers to verify if given verification attempt was originated from device with matching phone number.","whatsapp":"Verification by WhatsApp message with an OTP code."},"enum":["sms","flashcall","callout","seamless","whatsapp"]}},"components/schemas/VerificationMethodReport":{"id":"components/schemas/VerificationMethodReport","kind":"json-schema","title":"VerificationMethodReport","data":{"type":"string","description":"The type of the verification.","example":"sms","x-enumDescriptions":{"sms":"Verification by SMS message with an OTP code.","flashcall":"Verification by placing a flashVerificationResultEvent call (missed call) and detecting the incoming calling number (CLI).","callout":"Verification by placing a PSTN call to the user's phone and playing an announcement, asking the user to press a particular digit to verify the phone number.","whatsapp":"Verification by WhatsApp message with an OTP code."},"enum":["sms","flashcall","callout","whatsapp"]}},"components/schemas/SmsCodeType":{"id":"components/schemas/SmsCodeType","kind":"json-schema","title":"SmsCodeType","data":{"type":"string","description":"Selects type of code which will be sent to customer","default":"Numeric","x-enumDescriptions":{"Numeric":"Code contains numbers only.","Alpha":"Code contains letters only.","Alphanumeric":"Code contains both numbers and letters."},"enum":["Numeric","Alpha","Alphanumeric"]}},"components/schemas/WhatsAppCodeType":{"id":"components/schemas/WhatsAppCodeType","kind":"json-schema","title":"WhatsAppCodeType","data":{"type":"string","description":"Selects type of code which will be sent to customer","default":"Numeric","x-enumDescriptions":{"Numeric":"Code contains numbers only.","Alpha":"Code contains letters only.","Alphanumeric":"Code contains both numbers and letters."},"enum":["Numeric","Alpha","Alphanumeric"]}},"components/schemas/SmsExpiry":{"id":"components/schemas/SmsExpiry","kind":"json-schema","title":"SmsExpiry","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiration time for a verification process is represented in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/FlashCallDialTimeout":{"id":"components/schemas/FlashCallDialTimeout","kind":"json-schema","title":"FlashCallDialTimeout","data":{"type":"integer","description":"The amount of time that a phone will ring.","maximum":120,"minimum":5}},"components/schemas/FlashCallInterceptionTimeout":{"id":"components/schemas/FlashCallInterceptionTimeout","kind":"json-schema","title":"FlashCallInterceptionTimeout","data":{"type":"integer","description":"The maximum time that a phone call verification will be active and can be completed. If the phone number hasn't been verified successfully during this time, then the verification request will fail. By default, the Sinch dashboard will automatically optimize dial time out during a phone call.","maximum":120,"minimum":5}},"components/schemas/VerificationStatus":{"id":"components/schemas/VerificationStatus","kind":"json-schema","title":"VerificationStatus","data":{"type":"string","description":"The status of the verification","example":"PENDING","x-enumDescriptions":{"PENDING":"The verification is ongoing.","SUCCESSFUL":"The verification was successful.","FAIL":"The verification attempt was made, but the number wasn't verified.","DENIED":"The verification attempt was denied by Sinch or your backend.","ABORTED":"The verification attempt was aborted by requesting a new verification.","ERROR":"The verification couldn't be completed due to a network error or the number being unreachable."},"enum":["PENDING","SUCCESSFUL","FAIL","DENIED","ABORTED","ERROR"]}},"components/schemas/VerificationStatusReason":{"id":"components/schemas/VerificationStatusReason","kind":"json-schema","title":"VerificationStatusReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the reason why a verification has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DENIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-enumDescriptions":{"Fraud":"Fraudulent activity.","Not enough credit":"Not enough credit in dashboard account.","Blocked":"Blocked number.","Denied by callback":"Callback response denied the verification.","Invalid callback":"Callback was invalid.","Internal error":"Internal server error.","Destination denied":"Verification destination denied.","Network error or number unreachable":"Network error or destination number is otherwise unreachable.","Failed pending":"Pending failure.","SMS delivery failure":"Could not deliver SMS.","Invalid CLI":"CLI is invalid.","Invalid code":"Input code is invalid.","Expired":"Verification request has expired.","Hung up without entering valid code":"Phone call ended without entering code."},"enum":["Fraud","Not enough credit","Blocked","Denied by callback","Invalid callback","Internal error","Destination denied","Network error or number unreachable","Failed pending","SMS delivery failure","Invalid CLI","Invalid code","Expired","Hung up without entering valid code"],"example":"Expired"}},"components/schemas/VerificationStartRequestBase":{"id":"components/schemas/VerificationStartRequestBase","kind":"json-schema","title":"VerificationStartRequestBase","data":{"type":"object","additionalProperties":false,"required":["identity","method"],"properties":{"identity":{"$ref":"#/components/schemas/Identity"},"method":{"$ref":"#/components/schemas/VerificationMethodStart"},"reference":{"$ref":"#/components/schemas/VerificationEventReference"},"custom":{"$ref":"#/components/schemas/VerificationEventCustom"}}}},"components/schemas/VerificationStartRequestFlashCall":{"id":"components/schemas/VerificationStartRequestFlashCall","kind":"json-schema","title":"VerificationStartRequestFlashCall","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStartRequestBase"},{"type":"object","properties":{"flashCallOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional configuration for Flash Call Verification, should be used only when the verification request originates from your backend (not an end user device) and request is signed via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/voice/api-reference/authentication/signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application signed request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"properties":{"dialTimeout":{"$ref":"#/components/schemas/FlashCallDialTimeout"},"interceptionTimeout":{"$ref":"#/components/schemas/FlashCallInterceptionTimeout"}}}}}]}},"components/schemas/VerificationStartRequestSms":{"id":"components/schemas/VerificationStartRequestSms","kind":"json-schema","title":"VerificationStartRequestSms","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStartRequestBase"},{"type":"object","properties":{"smsOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional configuration for Sms Verification, should be used only when the verification request originates from your backend (not an end user device) and request is signed via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/voice/api-reference/authentication/signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application signed request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"properties":{"codeType":{"$ref":"#/components/schemas/SmsCodeType"},"expiry":{"$ref":"#/components/schemas/SmsExpiry"}}}}}]}},"components/schemas/VerificationStartRequestWhatsApp":{"id":"components/schemas/VerificationStartRequestWhatsApp","kind":"json-schema","title":"VerificationStartRequestWhatsApp","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStartRequestBase"},{"type":"object","properties":{"whatsappOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional configuration for WhatsApp Verification, should be used only when the verification request originates from your backend (not an end user device) and request is signed via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/voice/api-reference/authentication/signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application signed request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"properties":{"codeType":{"$ref":"#/components/schemas/WhatsAppCodeType"}}}}}]}},"components/schemas/VerificationStartRequestPhoneCall":{"id":"components/schemas/VerificationStartRequestPhoneCall","kind":"json-schema","title":"VerificationStartRequestPhoneCall","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStartRequestBase"},{"type":"object","properties":{"calloutOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional configuration for Phone Call Verification, should be used only when the verification request originates from your backend (not an end user device) and request is signed via an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/voice/api-reference/authentication/signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application signed request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"properties":{"speech":{"$ref":"#/components/schemas/PhoneCallSpeech"}}}}}]}},"components/schemas/VerificationStartRequestData":{"id":"components/schemas/VerificationStartRequestData","kind":"json-schema","title":"VerificationStartRequestData","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStartRequestBase"}]}},"components/schemas/VerificationStartRequest":{"id":"components/schemas/VerificationStartRequest","kind":"json-schema","title":"VerificationStartRequest","data":{"type":"object","additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/VerificationStartRequestData"},{"$ref":"#/components/schemas/VerificationStartRequestFlashCall"},{"$ref":"#/components/schemas/VerificationStartRequestPhoneCall"},{"$ref":"#/components/schemas/VerificationStartRequestSms"},{"$ref":"#/components/schemas/VerificationStartRequestWhatsApp"}],"discriminator":{"propertyName":"method","mapping":{"seamless":"#/components/schemas/VerificationStartRequestData","flashcall":"#/components/schemas/VerificationStartRequestFlashCall","callout":"#/components/schemas/VerificationStartRequestPhoneCall","sms":"#/components/schemas/VerificationStartRequestSms","whatsapp":"#/components/schemas/VerificationStartRequestWhatsApp"}}}},"components/schemas/PhoneCallSpeech":{"id":"components/schemas/PhoneCallSpeech","kind":"json-schema","title":"PhoneCallSpeech","data":{"type":"object","description":"Text-To-Speech engine settings","properties":{"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language-region"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier according to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IANA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only a subset of those identifiers is accepted."},"children":[]}]}]}],"default":"en-US"}}}},"components/schemas/Identity":{"id":"components/schemas/Identity","kind":"json-schema","title":"Identity","data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of endpoint that will be verified and the particular endpoint. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently the only supported endpoint type."},"children":[]}]}]}],"required":["type","endpoint"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type is supported."},"children":[]}]}]}],"x-enumDescriptions":{"number":"Identity is of number type"},"enum":["number"]},"endpoint":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-compatible phone number."},"children":[]}]}]}],"example":"+11235551234"}}}},"components/schemas/VerificationStatusResponse":{"id":"components/schemas/VerificationStatusResponse","kind":"json-schema","title":"VerificationStatusResponse","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/VerificationStatusResponseSms"},{"$ref":"#/components/schemas/VerificationStatusResponseFlashCall"},{"$ref":"#/components/schemas/VerificationStatusResponsePhoneCall"},{"$ref":"#/components/schemas/VerificationStatusResponseWhatsApp"}],"discriminator":{"propertyName":"method","mapping":{"sms":"#/components/schemas/VerificationStatusResponseSms","flashcall":"#/components/schemas/VerificationStatusResponseFlashCall","callout":"#/components/schemas/VerificationStatusResponsePhoneCall","whatsapp":"#/components/schemas/VerificationStatusResponseWhatsApp"}}}},"components/schemas/VerificationReportResponseBase":{"id":"components/schemas/VerificationReportResponseBase","kind":"json-schema","title":"VerificationReportResponseBase","data":{"type":"object","additionalProperties":false,"required":["method"],"properties":{"id":{"type":"string","description":"The unique ID of the verification request.","example":"1234567890"},"method":{"$ref":"#/components/schemas/VerificationMethodReport"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"reason":{"$ref":"#/components/schemas/VerificationStatusReason"}}}},"components/schemas/VerificationReportResponseFlashCall":{"id":"components/schemas/VerificationReportResponseFlashCall","kind":"json-schema","title":"VerificationReportResponseFlashCall","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationReportResponseBase"},{"type":"object","properties":{"callComplete":{"type":"boolean","description":"Displays if the call was completed successfully."}}}]}},"components/schemas/VerificationReportResponsePhoneCall":{"id":"components/schemas/VerificationReportResponsePhoneCall","kind":"json-schema","title":"VerificationReportResponsePhoneCall","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationReportResponseBase"},{"type":"object","properties":{"callComplete":{"type":"boolean","description":"Displays if the call was completed successfully."}}}]}},"components/schemas/VerificationReportResponseSms":{"id":"components/schemas/VerificationReportResponseSms","kind":"json-schema","title":"VerificationReportResponseSms","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationReportResponseBase"}]}},"components/schemas/VerificationReportResponseWhatsApp":{"id":"components/schemas/VerificationReportResponseWhatsApp","kind":"json-schema","title":"VerificationReportResponseWhatsApp","data":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationReportResponseBase"}]}},"components/schemas/VerificationReportResponse":{"id":"components/schemas/VerificationReportResponse","kind":"json-schema","title":"Verification Report Response","data":{"title":"Verification Report Response","type":"object","additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/VerificationReportResponseFlashCall"},{"$ref":"#/components/schemas/VerificationReportResponsePhoneCall"},{"$ref":"#/components/schemas/VerificationReportResponseSms"},{"$ref":"#/components/schemas/VerificationReportResponseWhatsApp"}],"discriminator":{"propertyName":"method","mapping":{"flashcall":"#/components/schemas/VerificationReportResponseFlashCall","callout":"#/components/schemas/VerificationReportResponsePhoneCall","sms":"#/components/schemas/VerificationReportResponseSms","whatsapp":"#/components/schemas/VerificationReportResponseWhatsApp"}}}},"components/schemas/VerificationReportRequest":{"id":"components/schemas/VerificationReportRequest","kind":"json-schema","title":"VerificationReportRequest","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/VerificationReportRequestSms"},{"$ref":"#/components/schemas/VerificationReportRequestFlashCall"},{"$ref":"#/components/schemas/VerificationReportRequestPhoneCall"},{"$ref":"#/components/schemas/VerificationReportRequestWhatsApp"}],"discriminator":{"propertyName":"method","mapping":{"sms":"#/components/schemas/VerificationReportRequestSms","flashcall":"#/components/schemas/VerificationReportRequestFlashCall","callout":"#/components/schemas/VerificationReportRequestPhoneCall","whatsapp":"#/components/schemas/VerificationReportRequestWhatsApp"}}}},"components/schemas/VerificationReportRequestSms":{"id":"components/schemas/VerificationReportRequestSms","kind":"json-schema","title":"SMS Verification Report Request","data":{"title":"SMS Verification Report Request","type":"object","required":["method","sms"],"properties":{"method":{"type":"string","description":"The type of verification.","x-enumDescriptions":{"sms":"SMS verification type"},"enum":["sms"],"example":"sms"},"sms":{"required":["code"],"description":"A configuration object containing settings specific to SMS verifications.","type":"object","properties":{"code":{"type":"string","description":"The code which was received by the user submitting the SMS verification.","example":"123"}}}}}},"components/schemas/VerificationReportRequestWhatsApp":{"id":"components/schemas/VerificationReportRequestWhatsApp","kind":"json-schema","title":"WhatsApp Verification Report Request","data":{"title":"WhatsApp Verification Report Request","type":"object","required":["method","whatsapp"],"properties":{"method":{"type":"string","description":"The type of verification.","x-enumDescriptions":{"whatsapp":"WhatsApp verification type"},"enum":["whatsapp"],"example":"whatsapp"},"whatsapp":{"required":["code"],"description":"A configuration object containing settings specific to WhatsApp verifications.","type":"object","properties":{"code":{"type":"string","description":"The code which was received by the user submitting the WhatsApp verification.","example":"123"}}}}}},"components/schemas/VerificationStatusResponseSms":{"id":"components/schemas/VerificationStatusResponseSms","kind":"json-schema","title":"SMS Verification Status Response","data":{"title":"SMS Verification Status Response","type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStatusResponseBase"},{"type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method of the verification request. This will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-enumDescriptions":{"sms":"Verification is of SMS type"},"enum":["sms"]},"price":{"type":"object","description":"Prices associated with this verification","properties":{"verificationPrice":{"$ref":"#/components/schemas/VerificationPrice"}}},"source":{"$ref":"#/components/schemas/Source"}}}]}},"components/schemas/VerificationStatusResponseFlashCall":{"id":"components/schemas/VerificationStatusResponseFlashCall","kind":"json-schema","title":"Flash Call Verification Status Response","data":{"title":"Flash Call Verification Status Response","type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStatusResponseBase"},{"type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method of the verification request. This will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flashcall"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-enumDescriptions":{"flashcall":"Verification is of flashcall type"},"enum":["flashcall"]},"callComplete":{"type":"boolean","description":"Shows whether the call is complete or not.","example":true},"callResult":{"$ref":"#/components/schemas/StatusCallResult"},"price":{"$ref":"#/components/schemas/StatusPrice"},"source":{"$ref":"#/components/schemas/Source"}}}]}},"components/schemas/VerificationStatusResponseWhatsApp":{"id":"components/schemas/VerificationStatusResponseWhatsApp","kind":"json-schema","title":"WhatsApp Verification Status Response","data":{"title":"WhatsApp Verification Status Response","type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStatusResponseBase"},{"type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method of the verification request. This will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-enumDescriptions":{"whatsapp":"Verification is of WhatsApp type"},"enum":["whatsapp"]},"price":{"type":"object","description":"Prices associated with this verification","properties":{"verificationPrice":{"$ref":"#/components/schemas/VerificationPrice"}}},"source":{"$ref":"#/components/schemas/Source"}}}]}},"components/schemas/VerificationReportRequestFlashCall":{"id":"components/schemas/VerificationReportRequestFlashCall","kind":"json-schema","title":"Flash Call Verification Report Request","data":{"title":"Flash Call Verification Report Request","required":["method","flashCall"],"properties":{"method":{"type":"string","description":"The type of verification.","example":"flashcall","x-enumDescriptions":{"flashcall":"Verification is of flashcall type"},"enum":["flashcall"]},"flashCall":{"required":["cli"],"description":"A configuration object containing settings specific to flash call verifications.","type":"object","properties":{"cli":{"type":"string","description":"The caller ID of the flash call. Caller ID in flash call verification refers to the phone number from which the call was made to the user's device. The verification system uses this incoming number as One Time Password (OTP)","example":"+46000000000"}}}}}},"components/schemas/Links":{"id":"components/schemas/Links","kind":"json-schema","title":"Links","data":{"type":"object","description":"Available methods and actions which can be done after a successful Verification","properties":{"rel":{"type":"string","description":"The related action that can be performed on the initiated Verification.","x-enumDescriptions":{"status":"Get the status of a Verification.","report":"Report a verification."},"enum":["status","report"],"example":"status"},"href":{"type":"string","description":"The complete URL to perform the specified action, localized to the DataCenter which handled the original Verification request."},"method":{"type":"string","description":"The HTTP method to use when performing the action using the linked localized URL.","example":"GET"}}}},"components/schemas/VerificationReportRequestPhoneCall":{"id":"components/schemas/VerificationReportRequestPhoneCall","kind":"json-schema","title":"Phone Call Verification Report Request","data":{"title":"Phone Call Verification Report Request","required":["method","callout"],"properties":{"method":{"type":"string","description":"The type of verification.","example":"callout","x-enumDescriptions":{"callout":"Verification is of Phone Call type"},"enum":["callout"]},"callout":{"type":"object","description":"A configuration object containing settings specific to Phone Call verifications.","properties":{"code":{"type":"string","description":"The code which was received by the user submitting the Phone Call verification."}}}}}},"components/schemas/VerificationStatusResponseBase":{"id":"components/schemas/VerificationStatusResponseBase","kind":"json-schema","title":"Verification Status Response Common Fields","data":{"title":"Verification Status Response Common Fields","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"The unique ID of the verification request.","example":"1234567890"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"reason":{"$ref":"#/components/schemas/VerificationStatusReason"},"reference":{"$ref":"#/components/schemas/VerificationEventReference"},"identity":{"$ref":"#/components/schemas/Identity"},"countryId":{"$ref":"#/components/schemas/CountryId"},"verificationTimestamp":{"$ref":"#/components/schemas/VerificationTimestamp"}}}},"components/schemas/VerificationStatusResponsePhoneCall":{"id":"components/schemas/VerificationStatusResponsePhoneCall","kind":"json-schema","title":"Phone Call Verification Status Response","data":{"title":"Phone Call Verification Status Response","type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VerificationStatusResponseBase"},{"type":"object","properties":{"method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method of the verification request. This will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-enumDescriptions":{"callout":"Verification is of Phone Call type"},"enum":["callout"]},"callComplete":{"type":"boolean","description":"Shows whether the call is complete or not.","example":true},"callResult":{"$ref":"#/components/schemas/StatusCallResult"},"price":{"$ref":"#/components/schemas/StatusPrice"}}}]}},"components/schemas/StatusPrice":{"id":"components/schemas/StatusPrice","kind":"json-schema","title":"StatusPrice","data":{"type":"object","description":"Prices associated with this verification","properties":{"verificationPrice":{"$ref":"#/components/schemas/VerificationPrice"},"terminationPrice":{"$ref":"#/components/schemas/TerminationPrice"},"billableDuration":{"$ref":"#/components/schemas/BillableDuration"}}}},"components/schemas/VerificationPrice":{"id":"components/schemas/VerificationPrice","kind":"json-schema","title":"VerificationPrice","data":{"allOf":[{"$ref":"#/components/schemas/Price"}],"description":"The maximum price charged for this verification process.\n\nThis property will appear in the body of the response with a delay. \nIt will become visible only when the verification status is other than PENDING.\n"}},"components/schemas/TerminationPrice":{"id":"components/schemas/TerminationPrice","kind":"json-schema","title":"TerminationPrice","data":{"allOf":[{"$ref":"#/components/schemas/Price"}],"description":"The maximum cost of the call made during this verification process.\n\nPresent only when termination debiting is enabled (disabled by default).\n\nThis property will appear in the body of the response with a delay. \nIt will become visible only after the call is completed, when its cost is known to Sinch.\n"}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"title":"Price","type":"object","additionalProperties":false,"properties":{"currencyId":{"type":"string","description":"ISO 4217 currency code","example":"USD"},"amount":{"type":"number","format":"float","example":0.0127}}}},"components/schemas/BillableDuration":{"id":"components/schemas/BillableDuration","kind":"json-schema","title":"BillableDuration","data":{"description":"The time of the call for which the fee was charged.\n\nPresent only when termination debiting is enabled (disabled by default).\n\nDepending on the type of rounding used, the value is the actual call time rounded to the nearest second, minute or other value.\n","type":"integer","example":42}},"components/schemas/VerificationTimestamp":{"id":"components/schemas/VerificationTimestamp","kind":"json-schema","title":"VerificationTimestamp","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp in UTC format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The formatting does not respect "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO-8601"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the returned value has the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.SSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you need to parse this value into a specific date object in your programming language, please append "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zulu time = UTC) at the end of the date value to match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO-8601"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss.SSSZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2023-04-21T14:45:51"}},"components/schemas/CountryId":{"id":"components/schemas/CountryId","kind":"json-schema","title":"CountryId","data":{"type":"string","description":"The ID of the country to which the verification was sent.","example":"US"}},"schema_1032":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1032"}},"exampleStore":{"components/examples/verificationRequestFlashCall":{"id":"components/examples/verificationRequestFlashCall","value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"flashcall"},"summary":"Flash Call"},"components/examples/verificationRequestSms":{"id":"components/examples/verificationRequestSms","value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"sms"},"summary":"SMS"},"components/examples/verificationRequestPhoneCall":{"id":"components/examples/verificationRequestPhoneCall","value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"callout"},"summary":"Phone Call"},"components/examples/verificationRequestData":{"id":"components/examples/verificationRequestData","value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"seamless"},"summary":"Data (seamless)"},"components/examples/verificationRequestWhatsApp":{"id":"components/examples/verificationRequestWhatsApp","value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"whatsapp"},"summary":"WhatsApp"},"components/examples/SmsRequestEventResponse":{"id":"components/examples/SmsRequestEventResponse","value":{"action":"allow","sms":{"code":"3688","acceptLanguage":["en-US"]}},"summary":"SMS OTP"},"components/examples/WhatsAppRequestEventResponse":{"id":"components/examples/WhatsAppRequestEventResponse","value":{"action":"allow","whatsapp":{"acceptLanguage":["en-US"]}},"summary":"WhatsApp OTP"},"components/examples/FlashCallRequestEventResponse":{"id":"components/examples/FlashCallRequestEventResponse","value":{"action":"allow","flashCall":{"cli":"+46700000000","dialTimeout":10}},"summary":"Flash Call"},"components/examples/PhoneCallRequestEventResponse":{"id":"components/examples/PhoneCallRequestEventResponse","value":{"action":"allow","callout":{"code":"1234","speech":{"locale":"en_US"}}},"summary":"Phone Call"},"components/examples/40001Example":{"id":"components/examples/40001Example","value":{"errorCode":40001,"message":"Number +4813 is invalid. Too short."},"summary":"40001 error","description":"A 40001 parameter validation error."},"components/examples/40002Example":{"id":"components/examples/40002Example","value":{"errorCode":40002,"message":"Endpoint parameter is missing."},"summary":"40002 error","description":"A 40002 missing parameter error."},"components/examples/40003Example":{"id":"components/examples/40003Example","value":{"errorCode":40003,"message":"Invalid identity or code."},"summary":"40003 error","description":"A 40003 invalid request error."},"components/examples/40005Example":{"id":"components/examples/40005Example","value":{"errorCode":40002,"message":"Phone number missing leading plus sign"},"summary":"40005 error","description":"A 40005 number missing leading plus error."},"components/examples/40100Example":{"id":"components/examples/40100Example","value":{"errorCode":40100,"message":"Invalid authorization header"},"summary":"40100 error","description":"A 40100 invalid authorization header error."},"components/examples/40101Example":{"id":"components/examples/40101Example","value":{"errorCode":40101,"message":"X-Timestamp required"},"summary":"40101 error","description":"A 40101 timestamp header error."},"components/examples/40102Example":{"id":"components/examples/40102Example","value":{"errorCode":40102,"message":"Invalid signature"},"summary":"40102 error","description":"A 40102 invalid signature error."},"components/examples/40104Example":{"id":"components/examples/40104Example","value":{"errorCode":40104,"message":"Authorization required"},"summary":"40104 error","description":"A 40104 authorization required error."},"components/examples/40107Example":{"id":"components/examples/40107Example","value":{"errorCode":40107,"message":"Invalid authorization"},"summary":"40107 error","description":"A 40107 invalid authorization error."},"components/examples/40200Example":{"id":"components/examples/40200Example","value":{"errorCode":40200,"message":"Not enough credit"},"summary":"40200 error","description":"A 40200 not enough credit error."},"components/examples/40300Example":{"id":"components/examples/40300Example","value":{"errorCode":40300,"message":"Identity is blacklisted."},"summary":"40300 error","description":"A 40300 forbidden request error."},"components/examples/40303Example":{"id":"components/examples/40303Example","value":{"errorCode":40303,"message":"Callback URL must be set when using public authorization method."},"summary":"40303 error","description":"A 40303 restricted action error."},"components/examples/40400Example":{"id":"components/examples/40400Example","value":{"errorCode":40400,"message":"Requested resource was not found."},"summary":"40400 error","description":"A 40400 resource not found error."},"components/examples/40900Example":{"id":"components/examples/40900Example","value":{"errorCode":40900,"message":"Reference already defined"},"summary":"40900 error","description":"A 40900 request conflict error."},"components/examples/42200Example":{"id":"components/examples/42200Example","value":{"errorCode":42200,"message":"Application name has not been configured"},"summary":"42200 error","description":"A 42200 application configuration error."},"components/examples/42201Example":{"id":"components/examples/42201Example","value":{"errorCode":42201,"message":"No route to destination."},"summary":"42201 error","description":"A 42201 application configuration error."},"components/examples/42900Example":{"id":"components/examples/42900Example","value":{"errorCode":42900,"message":"Request capacity exceeded"},"summary":"42900 error","description":"A 42900 capacity exceeded error."},"components/examples/42901Example":{"id":"components/examples/42901Example","value":{"errorCode":42901,"message":"Cannot initiate verification to the same number too quickly"},"summary":"42901 error","description":"A 42901 velocity constraint error."},"components/examples/50000Example":{"id":"components/examples/50000Example","value":{"errorCode":50000,"message":"Internal server error."},"summary":"50000 error","description":"A 50000 internal server error."},"components/examples/50300Example":{"id":"components/examples/50300Example","value":{"errorCode":50300,"message":"Service is temporarily unavailable, please try again later."},"summary":"50300 error","description":"A 50300 temporary down error."},"components/examples/50301Example":{"id":"components/examples/50301Example","value":{"errorCode":50301,"message":"Configuration error, please contact support."},"summary":"50301 error","description":"A 50301 configuration error."},"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestSms":{"value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"sms"},"key":"verificationRequestSms","summary":"SMS","id":"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestSms"},"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestFlashCall":{"value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"flashcall"},"key":"verificationRequestFlashCall","summary":"Flash Call","id":"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestFlashCall"},"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestPhoneCall":{"value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"callout"},"key":"verificationRequestPhoneCall","summary":"Phone Call","id":"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestPhoneCall"},"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestData":{"value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"seamless"},"key":"verificationRequestData","summary":"Data (seamless)","id":"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestData"},"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestWhatsApp":{"value":{"identity":{"type":"number","endpoint":"+46700000000"},"method":"whatsapp"},"key":"verificationRequestWhatsApp","summary":"WhatsApp","id":"paths/~1verification~1v1~1verifications/post/requestBody/content/application~1json/examples/verificationRequestWhatsApp"}},"securitySchemeStore":{"Basic":{"id":"Basic","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Application":{"id":"Application","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authentication"}},"servers":[{"url":"https://verification.api.sinch.com"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/verification/api-reference/verification","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/verification/api-reference/verification.json?download"},{"url":"/_bundle/docs/verification/api-reference/verification.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Verification | Sinch","description":"Sinch offers a platform for phone number verification. It consists of different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services as well as a REST API. Together, they enable SMS, Flashcall, Phone Call, and Data verification in your application.\n\nVerify users with SMS, flash calls (missed calls), a regular call, or data verification. This document serves as a user guide and documentation on how to use the Sinch Verification REST APIs.\n\nThe Sinch Verification API is used to verify mobile phone numbers. It's consumed by the Sinch Verification SDK, but it can also be used by any backend or client directly.\n\nThe Sinch service uses four different verification methods:\n\n- [SMS](https://developers.sinch.com/docs/verification/api-reference/verification/section/sms-verification): Sending an SMS message with an OTP code\n- [FlashCall](https://developers.sinch.com/docs/verification/api-reference/verification/section/flashcall-verification): Placing a flashcall (missed call) and detecting the incoming calling number (CLI)\n- [Phone Call](https://developers.sinch.com/docs/verification/api-reference/verification/section/phone-call-verification): Placing a PSTN call to the user's phone and playing a message containing the code\n- [Data](https://developers.sinch.com/docs/verification/api-reference/verification/section/data-verification): By accessing internal infrastructure of mobile carriers to verify if given verification attempt was originated from device with matching phone number\n\n{% admonition type=\"info\" name=\"Note:\" %}\nIf you want to use data verification, please contact your account manager.\n{% /admonition %}\n\n## Authentication\n\nFor general information on how to use the Sinch APIs including methods, types, errors and authorization, please visit the [Authentication](https://developers.sinch.com/docs/verification/api-reference/authentication/) page.\n\nAvailable authentication methods are:\n\n- [Application Signed Request](https://developers.sinch.com/docs/verification/api-reference/authentication/application-signed-request): Strongest method, recommended for production use\n- [Basic Authentication](https://developers.sinch.com/docs/verification/api-reference/authentication/basic-authentication): Strong and easy, recommended for prototyping\n- [Public Authentication](https://developers.sinch.com/docs/verification/api-reference/authentication/public-authentication): Weak method, suitable only for specific scenarios\n\n### Authorization\n\nYou can set the minimum required authentication level in the Dashboard. Verification API rejects requests using weaker authentication methods than configured. Some endpoints may require stronger authentication than the set minimum.\n\n# FlashCall verification\n\nWith the flashCall verification method, a user's phone number is verified by triggering a \"missed call\" towards this number. The call is automatically intercepted by the Android SDK in the mobile app and blocked automatically. iOS and JavaScript use cases require manual interaction where user has to enter incoming phone call number in the application.\n\nTo initiate a flashCall verification, visit [Android SDK documentation](https://developers.sinch.com/docs/verification/android/android-the-verification-process). For additional security, it's recommended that you control which verification requests should proceed and which ones not, by listening in your backend for the [Verification Request Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationrequestevent) and respond accordingly. Your backend will be notified on the result of the verification with the [Verification Result Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationresultevent).\n\n# SMS verification\n\nWith the SMS verification method, a user's phone number is verified by sending an SMS containing an OTP code to this number. In the case of iOS or JavaScript, the user needs to enter the OTP manually or semi-manually in the application, while for Android there is an option of intercepting the SMS message delivery and capturing the OTP code automatically.\n\nTo initiate an SMS verification, check the [iOS](https://developers.sinch.com/docs/verification/ios.md) or [Android](https://developers.sinch.com/docs/verification/android.md) documentation. For additional security, it's recommended that you control which verification requests should proceed and which ones not, by listening in your backend for the [Verification Request Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationrequestevent) and respond accordingly. Your backend will be notified on the result of the verification with the [Verification Result Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationresultevent).\n\n## Set SMS language\n\nIt's possible to specify the content language for SMS verification. The desired language is set in the initiate verification request 'Accept-Language' header. Setting this header is optional. If not included the application's default SMS content language is used, which by default is en-US. If an SMS template for the desired language is not found it's defaulted to 'en-US' unless a different default language has been defined for the requesting application.\nMore information on the 'Accept-Language' header can be found from [IETF](https://tools.ietf.org/html/rfc3282) and the [HTTP/1.1 documentation](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4).\n\n{% admonition type=\"info\" name=\"Note:\" %}\nThe content language specified in the API request or in the callback can be overridden by carrier provider specific templates, due to compliance and legal requirements, such as [US shortcode requirements](https://community.sinch.com/t5/SMS/Sinch-US-Short-Code-Onboarding-Overview/ta-p/7085).\n{% /admonition %}\n\n_Example_ - SMS verification specifying content language\n\n```html\nHeaders: ... Accept-Language: es-ES ... [POST]\nhttps://verification.api.sinch.com/verification/v1/verifications\n```\n\n```json\n{\n \"identity\": { \"type\": \"number\", \"endpoint\": \"+46700000001\" },\n \"method\": \"sms\"\n}\n```\n\nThe actual language that was selected is returned in the `Content-Language` HTTP content header. As outlined above, this may differ from the requested language due to either that language not having SMS content defined, or it being overridden by provider requirements.\n\n_Example_ - SMS verification response with selected content language\n\n#### Response\n\n```html\nHeaders: ... Content-Length: 103 Content-Language: es-ES Content-Type:\napplication/json; charset=utf-8 Expires: -1 ...\n```\n\n```json\n{\n \"id\": \"1087388\",\n \"sms\": {\n \"template\": \"Tu código de verificación es {{CODE}}.\",\n \"interceptionTimeout\": 120\n }\n}\n```\n\n# Phone Call verification\n\nWith the Phone Call verification method, a user's phone number is verified by receiving a phone call and hearing a pre-recorded or text-to-speech message containing OTP code. The user is then expected to enter this code in the application.\n\nTo initiate a Phone Call verification, check the [Start Verification](https://developers.sinch.com/docs/verification/api-reference/verification/verifications-start/startverification) documentation. For additional security, it's recommended that you control which verification requests should proceed and which ones not, by listening in your backend for the [Verification Request Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationrequestevent) and respond accordingly. Your backend will be notified on the result of the verification with the [Verification Result Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationresultevent).\n\n# Data verification\n\nWith the data verification method, a user's phone number is verified by mobile carrier's infrastructure itself. This method requires cellular data usage on end-user's device and is currently limited in its coverage.\n\n{% admonition type=\"info\" name=\"Note:\" %}\nIf you want to use data verification, please contact your account manager.\n{% /admonition %}\n\n# How to use the Verification APIs\n\nIn combination with the Mobile or Web SDK (recommended)\n\nThe following diagram shows how to use the Verification APIs when using the iOS, Android or JavaScript SDKs to initiate a verification.\n\n\n\n{% admonition type=\"warning\" name=\"Important!\" %}\nIn this scenario, the _Verification Request_ and _Report Verification_ APIs don't need to be called explicitly by the app, since the SDK is handling that for you.\n{% /admonition %}\n\nIf you have configured a verification callback URL in the Sinch Portal (recommended), with every verification that's initiated by the app, Sinch will send a [Verification Request Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationrequestevent) to your backend, to get permission to perform the verification. If your backend allows the verification request to proceed, Sinch will trigger a flashcall, SMS or call towards the phone to be verified. Once the phone receives the flash-call, SMS or voice call, the SDK will report back the CLI or OTP respectively so that the Sinch dashboard can compare its validity. The Sinch backend responds with the result of the verification to the client and sends a [Verification Result Event](https://developers.sinch.com/docs/verification/api-reference/verification/verification-callbacks/verificationresultevent) to your backend. The status of a verification can also be queried ad-hoc by using the \"Query Verification\" APIs.\n\n## Without the mobile or web SDK\n\nIf you are not using the mobile or web Verification SDKs, then you need to implement all the client logic for intercepting calls (in case of flashcalls) and reporting the CLI or OTP (in case of SMS or Phone Call verification) inside your app. The following diagram shows how to use Sinch Verification in this scenario.\n\n\n\nThe verification requests will be triggered from your backend towards Sinch with the [Verification Request API](https://developers.sinch.com/docs/verification/api-reference/verification/verifications-start/startverification), by doing a [signed request](https://developers.sinch.com/docs/verification/api-reference/authentication/callback-signed-request). Sinch dashboard will respond with the CLI filter (for flashcalls) or the template (in case of an SMS), or the polling intervals (in case of a Phone Call). As soon as the flashcall or SMS is received by your app, your backend will need to report back to Sinch the CLI or OTP that was reported through the [Report Verification API](https://developers.sinch.com/docs/verification/api-reference/verification/verifications-report/reportverificationbyidentity). Sinch will respond with the result of the verification.\n"}},"baseSlug":"/docs/verification/api-reference/verification","routesMapping":{}}