{"items":[{"type":"link","label":"Sinch Sender ID Registrations API","link":"/docs/registration-api/api-reference/registrations","routeSlug":"/docs/registration-api/api-reference/registrations","content":{"contentType":"overview","meta":{"name":"Sinch Sender ID Registrations API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"registrations.json","url":"/_bundle/docs/registration-api/api-reference/registrations.json?download"},{"kind":"download","label":"registrations.yaml","url":"/_bundle/docs/registration-api/api-reference/registrations.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.sinch.com","url":"https://www.sinch.com"},{"kind":"email","title":"Support","email":"Support@sinch.com","label":"Support@sinch.com","withCopyButton":true,"copyContent":"Support@sinch.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://www.sinch.com/toc"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Production server","url":"https://senderid.registrations.api.sinch.com"},{"description":"Staging server","url":"https://senderid.numbers-registration.staging.sinch.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Sinch Sender ID Registrations API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This API describes the set of endpoints available to get each market requirements and create registration for sender IDs.\n\nThe list of endpoints allows to create, update and delete a registration and also get the current state.\nFor each market, customers can check the different requirements depending on the new sender ID scope, and also download templates to fill in for the registrations.\n\nInterested in this API? Please, reach out to your Account Manager for more info."}],"sectionId":"/docs/registration-api/api-reference/registrations"},{"nodeType":"external-docs","url":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth/","description":"All endpoints available under this API require Bearer token authentication. Please check oauth api documentation if you need more details."}],"sectionId":"/docs/registration-api/api-reference/registrations"}]}]}},{"type":"group","label":"Callback configuration","link":"/docs/registration-api/api-reference/registrations/callback-configuration","routeSlug":"/docs/registration-api/api-reference/registrations/callback-configuration","items":[{"label":"Get callback configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/callback-configuration/getcallbackconfiguration","routeSlug":"/docs/registration-api/api-reference/registrations/callback-configuration/getcallbackconfiguration","metadata":{"seo":{"title":"Get callback configuration","description":"The endpoint receives as path param project id. If the project exists, the details of the callback configuration are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCallbackConfiguration","name":"Get callback configuration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get callback configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint receives as path param project id. If the project exists, the details of the callback configuration are returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/callback-configuration","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/callback-configuration","href":"callback-configuration/getcallbackconfiguration","openApiOperationId":"getCallbackConfiguration","summary":"Get callback configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationResponse"}},"schemaId":"components/schemas/CallbackConfigurationResponse"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The project id introduced does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallbackConfigurationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationResponse"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/callback-configuration/getcallbackconfiguration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/callback-configuration"},{"label":"Update a callback configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/callback-configuration/updatecallbackconfiguration","routeSlug":"/docs/registration-api/api-reference/registrations/callback-configuration/updatecallbackconfiguration","metadata":{"seo":{"title":"Update a callback configuration","description":"The endpoint updates the callback configuration with specified project ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCallbackConfiguration","name":"Update a callback configuration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a callback configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint updates the callback configuration with specified project ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["write"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationUpdateBody"}},"schemaId":"components/schemas/CallbackConfigurationUpdateBody","pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/projects/{projectId}/callback-configuration","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationUpdateBody"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/callback-configuration","href":"callback-configuration/updatecallbackconfiguration","openApiOperationId":"updateCallbackConfiguration","summary":"Update a callback configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"schemaId":"components/schemas/CallbackConfigurationUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationResponse"}},"schemaId":"components/schemas/CallbackConfigurationResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST: Project validation error"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The project id introduced does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callback-configuration/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallbackConfigurationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationResponse"}}},{"code":"400","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/callback-configuration/updatecallbackconfiguration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/callback-configuration"}],"content":{"contentType":"group","meta":{"name":"callback-configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Callback configuration","showPageActions":true},{"nodeType":"markdoc","content":"You can set up callback URLs to receive event notifications when your registration status is updated.\nWhen delivering events the order is not guaranteed (for example, a failed event scheduled for retry will not block other events that were queued).\nThe client's callback handler must implement the state machine that can decide what to do with unexpected events, for example, \"old\" events or invalid state transitions. In these cases the handler could use the API to GET the latest state for the resource.\nThe callback handler is expected to \"ingest\" the event and respond with 200 OK. The domain-specific business logic and processes should be executed outside of the callback request, as internal asynchronous jobs.\nAn HMAC encrypted secret is used for hashing the payload and sending the hashed String via the X-Sinch-Signature header - that you can use to validate that an incoming request is secure. Hmac secret value can be checked with GET endpoint, and it can be updated with PUT endpoint"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/callback-configuration","summary":"Get callback configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/callback-configuration/getcallbackconfiguration","deprecated":false},{"title":"/v1/projects/{projectId}/callback-configuration","summary":"Update a callback configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/callback-configuration/updatecallbackconfiguration","deprecated":false}]}]}]}]}},{"type":"group","label":"Markets","link":"/docs/registration-api/api-reference/registrations/markets","routeSlug":"/docs/registration-api/api-reference/registrations/markets","items":[{"label":"Get market codes list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/markets/listavailablemarkets","routeSlug":"/docs/registration-api/api-reference/registrations/markets/listavailablemarkets","metadata":{"seo":{"title":"Get market codes list","description":"The endpoint retrieves the list of market codes available for alphanumeric registration. Market code is an optional query param, if used, the response will contain a list with the same market code if it is available; the list will be empty if it is not."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAvailableMarkets","name":"Get market codes list","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get market codes list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint retrieves the list of market codes available for alphanumeric registration. Market code is an optional query param, if used, the response will contain a list with the same market code if it is available; the list will be empty if it is not."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1availability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"marketCode","in":"query","schemaId":"schema_993","description":"Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)","example":"MK"},{"name":"language","in":"query","schemaId":"schema_994","description":"Language used to print country names. Default: en","example":"es"},{"name":"registrationType","in":"query","schemaId":"schema_995","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Sender ID to be registered. Options: ALPHANUMERIC_SENDER_ID for alpha registration, LONG_NUMBER for long number sms services registration, SHORT_CODE for short code sms services registration, RCS_AGENT for RCS agent"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/markets/availability","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"}],"query":[{"name":"marketCode","in":"query","example":"MK","schemaId":"schema_993"},{"name":"language","in":"query","example":"es","schemaId":"schema_994"},{"name":"registrationType","in":"query","schemaId":"schema_995"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","403","500"],"pointer":"/v1/projects/{projectId}/markets/availability","href":"markets/listavailablemarkets","openApiOperationId":"listAvailableMarkets","summary":"Get market codes list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAvailableMarketsResponse"}},"schemaId":"components/schemas/ListAvailableMarketsResponse"},{"code":"403","description":"Customer has no authorization for this API"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAvailableMarketsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAvailableMarketsResponse"}}},{"code":"403"},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/markets/listavailablemarkets"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/markets/availability"},{"label":"Get market versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/markets/listmarketversions","routeSlug":"/docs/registration-api/api-reference/registrations/markets/listmarketversions","metadata":{"seo":{"title":"Get market versions","description":"The endpoint will return the markets in active status according to the query parameters: market code and registration type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMarketVersions","name":"Get market versions","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get market versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint will return the markets in active status according to the query parameters: market code and registration type"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1details/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"marketCode","in":"query","schemaId":"schema_993","description":"Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)","example":"MK"},{"name":"activePolicies","in":"query","schemaId":"schema_996","description":"Filter to enable viewing only active policies in markets. Default: false, returns all policies within market"},{"name":"pageToken","in":"query","schemaId":"schema_992","description":"Add token from previous query if needed to retrieve more markets"},{"name":"pageSize","in":"query","schemaId":"schema_997","description":"Number of markets per page"},{"name":"registrationType","in":"query","schemaId":"schema_995","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Sender ID to be registered. Options: ALPHANUMERIC_SENDER_ID for alpha registration, LONG_NUMBER for long number sms services registration, SHORT_CODE for short code sms services registration, RCS_AGENT for RCS agent"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/markets/details","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"}],"query":[{"name":"marketCode","in":"query","example":"MK","schemaId":"schema_993"},{"name":"activePolicies","in":"query","schemaId":"schema_996"},{"name":"pageToken","in":"query","schemaId":"schema_992"},{"name":"pageSize","in":"query","schemaId":"schema_997"},{"name":"registrationType","in":"query","schemaId":"schema_995"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{projectId}/markets/details","href":"markets/listmarketversions","openApiOperationId":"listMarketVersions","summary":"Get market versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMarketVersionsResponse"}},"schemaId":"components/schemas/ListMarketVersionsResponse"},{"code":"400","description":"Token not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1markets~1details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMarketVersionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMarketVersionsResponse"}}},{"code":"400","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/markets/listmarketversions"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/markets/details"}],"content":{"contentType":"group","meta":{"name":"markets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Markets","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to get market availability and different options based on usage"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/markets/availability","summary":"Get market codes list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/markets/listavailablemarkets","deprecated":false},{"title":"/v1/projects/{projectId}/markets/details","summary":"Get market versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/markets/listmarketversions","deprecated":false}]}]}]}]}},{"type":"group","label":"Policies","link":"/docs/registration-api/api-reference/registrations/policies","routeSlug":"/docs/registration-api/api-reference/registrations/policies","items":[{"label":"Get policy details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/policies/getpolicy","routeSlug":"/docs/registration-api/api-reference/registrations/policies/getpolicy","metadata":{"seo":{"title":"Get policy details","description":"Returns the whole configuration of a given policyId, including multi configuration, fields, sections and attachments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPolicy","name":"Get policy details","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1policies~1{policyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get policy details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the whole configuration of a given policyId, including multi configuration, fields, sections and attachments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true},{"name":"policyId","in":"path","schemaId":"schema_992","description":"Id of the policy","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1policies~1{policyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/policies/{policyId}","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"},{"name":"policyId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/policies/{policyId}","href":"policies/getpolicy","openApiOperationId":"GetPolicy","summary":"Get policy details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Policy"}},"schemaId":"components/schemas/Policy"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: Policy Id introduced does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1policies~1{policyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Policy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Policy"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/getpolicy"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/policies/{policyId}"},{"label":"Download policy template file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/policies/downloadtemplate","routeSlug":"/docs/registration-api/api-reference/registrations/policies/downloadtemplate","metadata":{"seo":{"title":"Download policy template file","description":"Download a policy template. Use this enpdoint to download the template for those policy attachments which template value is true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadTemplate","name":"Download policy template file","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1policies~1{policyId}~1attachments~1{attachmentId}~1template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download policy template file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a policy template. Use this enpdoint to download the template for those policy attachments which template value is true."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_998","description":"Customer's project id","required":true},{"name":"policyId","in":"path","schemaId":"schema_999","description":"Policy id requested","required":true},{"name":"attachmentId","in":"path","schemaId":"schema_1000","description":"Attachment definition id requested","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1policies~1{policyId}~1attachments~1{attachmentId}~1template/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"eeew32344324edewe2e3","schemaId":"schema_998"},{"name":"policyId","in":"path","required":true,"example":"43342642354352344","schemaId":"schema_999"},{"name":"attachmentId","in":"path","required":true,"example":"324234762423034240","schemaId":"schema_1000"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","404"],"pointer":"/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template","href":"policies/downloadtemplate","openApiOperationId":"downloadTemplate","summary":"Download policy template file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Successful with binary file returned in octet stream","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1001"}},"schemaId":"schema_1001"},{"code":"404","description":"Policy/template not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1policies~1{policyId}~1attachments~1{attachmentId}~1template/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1001","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1001"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/downloadtemplate"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template"}],"content":{"contentType":"group","meta":{"name":"policies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Policies","showPageActions":true},{"nodeType":"markdoc","content":"Operation related to get policy required information, as fields, validations or attachments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/policies/{policyId}","summary":"Get policy details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policies/getpolicy","deprecated":false},{"title":"/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template","summary":"Download policy template file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policies/downloadtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Registrations","link":"/docs/registration-api/api-reference/registrations/registrations","routeSlug":"/docs/registration-api/api-reference/registrations/registrations","items":[{"label":"List registrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/listregistrations","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/listregistrations","metadata":{"seo":{"title":"List registrations","description":"The endpoint receives as path param project id. Supports optional query parameters to narrow the results and cursor based pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrations","name":"List registrations","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List registrations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint receives as path param project id. Supports optional query parameters to narrow the results and cursor based pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"registrationState","in":"query","schemaId":"schema_1002","description":"Status of the registration. ","example":"IN_QUEUE"},{"name":"tags","in":"query","schemaId":"schema_1003","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User tags used for the registration. Tag have to start from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and contains only alphanumerics and dashes."},"children":[]}]}]}],"example":["#tag1","#tag2"]},{"name":"marketCode","in":"query","schemaId":"schema_993","description":"Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)","example":"MK"},{"name":"createDateFrom","in":"query","schemaId":"schema_992","description":"Date of registration creation, ISO 8601 format. Returns registrations created after given date.","example":"2024-11-03"},{"name":"createDateTo","in":"query","schemaId":"schema_992","description":"Date of registration creation, ISO 8601 format. Returns registrations created before given date.","example":"2024-11-03"},{"name":"updateDateFrom","in":"query","schemaId":"schema_992","description":"Date of registration update, ISO 8601 format. Returns registrations update after given date.","example":"2024-11-03"},{"name":"updateDateTo","in":"query","schemaId":"schema_992","description":"Date of registration update, ISO 8601 format. Returns registrations updated before given date.","example":"2024-11-03"},{"name":"senderId","in":"query","schemaId":"schema_992","description":"Sender ID value.","example":"sender ID"},{"name":"orderBy","in":"query","schemaId":"schema_992","description":"Ordering of the results: field name with an optional order separated by a comma. Fields that support ordering are 'id', 'status', 'senderId', 'createDate', 'updateDate' with possible ordering 'desc' or 'asc'","example":"senderId,asc"},{"name":"pageSize","in":"query","schemaId":"schema_997","description":"Size of the page to be returned.","example":100},{"name":"pageToken","in":"query","schemaId":"schema_992","description":"Page token to request subsequent pages when using pagination. This should be the value generated by a system in a previous list request."},{"name":"registrationType","in":"query","schemaId":"schema_995","description":"Registration type for market used in registration is for. There are different markets available depending on this type"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/registrations","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"}],"query":[{"name":"registrationState","in":"query","example":"IN_QUEUE","schemaId":"schema_1002"},{"name":"tags","in":"query","example":["#tag1","#tag2"],"schemaId":"schema_1003"},{"name":"marketCode","in":"query","example":"MK","schemaId":"schema_993"},{"name":"createDateFrom","in":"query","example":"2024-11-03","schemaId":"schema_992"},{"name":"createDateTo","in":"query","example":"2024-11-03","schemaId":"schema_992"},{"name":"updateDateFrom","in":"query","example":"2024-11-03","schemaId":"schema_992"},{"name":"updateDateTo","in":"query","example":"2024-11-03","schemaId":"schema_992"},{"name":"senderId","in":"query","example":"sender ID","schemaId":"schema_992"},{"name":"orderBy","in":"query","example":"senderId,asc","schemaId":"schema_992"},{"name":"pageSize","in":"query","example":100,"schemaId":"schema_997"},{"name":"pageToken","in":"query","schemaId":"schema_992"},{"name":"registrationType","in":"query","schemaId":"schema_995"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","403","500"],"pointer":"/v1/projects/{projectId}/registrations","href":"registrations/listregistrations","openApiOperationId":"listRegistrations","summary":"List registrations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRegistrationsResponse"}},"schemaId":"components/schemas/ListRegistrationsResponse"},{"code":"403","description":"Customer has no authorization for this API"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRegistrationsResponse"}}},{"code":"403"},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/listregistrations"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations"},{"label":"Submit registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/createregistration","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/createregistration","metadata":{"seo":{"title":"Submit registration","description":"The endpoint creates a registration with specified policyId and registration's Data. The registration will be validated against the selected policy before submission. After this endpoint gets a 200, the registration will be in IN_QUEUE state, and will be editable. For those registrations that need attachments, they must be provided in a separated endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRegistration","name":"Submit registration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint creates a registration with specified policyId and registration's Data. The registration will be validated against the selected policy before submission. After this endpoint gets a 200, the registration will be in IN_QUEUE state, and will be editable. For those registrations that need attachments, they must be provided in a separated endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["write"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegistrationCreateBody"}},"schemaId":"components/schemas/RegistrationCreateBody","pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/registrations","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegistrationCreateBody"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/registrations","href":"registrations/createregistration","openApiOperationId":"createRegistration","summary":"Submit registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"schemaId":"components/schemas/RegistrationCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegistrationCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRegistrationResponse"}},"schemaId":"components/schemas/GetRegistrationResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST: Registration validation error"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: Policy not found"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRegistrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRegistrationResponse"}}},{"code":"400","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/callbackUrl}","summary":"Event notification","operationId":"postCallbackEvent","description":"Callback notification, these notifications are sent when registration POST operation contains a callbackUrl. Events are sent at any registration status update.","callbackName":"Registration Status Update","callbackId":"Registration Status Update/post","contentChildren":[{"nodeType":"security","requirements":[{"schemes":[{"name":"hmacAuth","scopes":[],"type":"http","scheme":"hmac","description":"Used for hashing callbacks. Please refer to the callback-configuration endpoints for more information."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Sinch-Signature","in":"header","schemaId":"schema_992","description":"Contains the request payload hashed using customers HMAC secret."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/callbacks/Registration Status Update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackEventBody"}},"schemaId":"components/schemas/CallbackEventBody","pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/callbacks/Registration Status Update/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"4XX","description":"Customer has refused callback event for any reason."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/callbacks/Registration Status Update/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Registration Status Update/post","path":"{$request.body#/callbackUrl}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1004"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/createregistration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations"},{"label":"Delete registration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/deleteregistration","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/deleteregistration","metadata":{"seo":{"title":"Delete registration","description":"The endpoint receives as path param project id and registration id. If the registration exists under the specified project id and the registration is in DRAFT, IN QUEUE or PENDING status, the registration will be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRegistration","name":"Delete registration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint receives as path param project id and registration id. If the registration exists under the specified project id and the registration is in DRAFT, IN QUEUE or PENDING status, the registration will be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["write"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true},{"name":"registrationId","in":"path","schemaId":"schema_992","description":"Id of the registration to be deleted","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/registrations/{registrationId}","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"},{"name":"registrationId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["write"]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/registrations/{registrationId}","href":"registrations/deleteregistration","openApiOperationId":"deleteRegistration","summary":"Delete registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST: Registration is not in DRAFT, IN QUEUE or PENDING status."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The registration id introduced does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/deleteregistration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations/{registrationId}"},{"label":"Get registration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/getregistration","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/getregistration","metadata":{"seo":{"title":"Get registration","description":"The endpoint receives as path param project id and registration id. If the registration exists under the specified project id, the details of the registration are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRegistration","name":"Get registration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint receives as path param project id and registration id. If the registration exists under the specified project id, the details of the registration are returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true},{"name":"registrationId","in":"path","schemaId":"schema_992","description":"Id of the registration","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/registrations/{registrationId}","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"},{"name":"registrationId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/registrations/{registrationId}","href":"registrations/getregistration","openApiOperationId":"getRegistration","summary":"Get registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRegistrationResponse"}},"schemaId":"components/schemas/GetRegistrationResponse"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The registration id introduced does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRegistrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRegistrationResponse"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/getregistration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations/{registrationId}"},{"label":"Update a registration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/updateregistration","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/updateregistration","metadata":{"seo":{"title":"Update a registration","description":"The endpoint updates the registration with specified ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRegistration","name":"Update a registration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint updates the registration with specified ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["write"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_992","description":"Customer's project id","required":true},{"name":"registrationId","in":"path","schemaId":"schema_992","description":"Id of the registration to be updated","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegistrationUpdateBody"}},"schemaId":"components/schemas/RegistrationUpdateBody","pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/projects/{projectId}/registrations/{registrationId}","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_992"},{"name":"registrationId","in":"path","required":true,"schemaId":"schema_992"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegistrationUpdateBody"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/registrations/{registrationId}","href":"registrations/updateregistration","openApiOperationId":"updateRegistration","summary":"Update a registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"schemaId":"components/schemas/RegistrationUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegistrationUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRegistrationResponse"}},"schemaId":"components/schemas/GetRegistrationResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST: Registration validation error"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_FOUND: The registration id introduced does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRegistrationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRegistrationResponse"}}},{"code":"400","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"500","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/updateregistration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations/{registrationId}"},{"label":"Download previous attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/downloadregistrationattachment","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/downloadregistrationattachment","metadata":{"seo":{"title":"Download previous attachment","description":"Download attachments previously added to the registration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadRegistrationAttachment","name":"Download previous attachment","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download previous attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download attachments previously added to the registration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_998","description":"Customer's project id","required":true},{"name":"registrationId","in":"path","schemaId":"schema_1005","description":"Registration id requested","required":true},{"name":"attachmentId","in":"path","schemaId":"schema_1000","description":"Attachment definition id requested","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"eeew32344324edewe2e3","schemaId":"schema_998"},{"name":"registrationId","in":"path","required":true,"example":"234235425jhl21132424lf","schemaId":"schema_1005"},{"name":"attachmentId","in":"path","required":true,"example":"324234762423034240","schemaId":"schema_1000"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["read"]}],"responseCodes":["200","404"],"pointer":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}","href":"registrations/downloadregistrationattachment","openApiOperationId":"downloadRegistrationAttachment","summary":"Download previous attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Successful with binary file returned in octet stream","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1001"}},"schemaId":"schema_1001"},{"code":"404","description":"registration/document not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1001","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1001"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/downloadregistrationattachment"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}"},{"label":"Upload attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/registration-api/api-reference/registrations/registrations/uploadregistrationattachment","routeSlug":"/docs/registration-api/api-reference/registrations/registrations/uploadregistrationattachment","metadata":{"seo":{"title":"Upload attachment","description":"Through this endpoint, attachments can be added to registrations. The required attachments for each registration can be retrieved from the get policy endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadRegistrationAttachment","name":"Upload attachment","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Through this endpoint, attachments can be added to registrations. The required attachments for each registration can be retrieved from the get policy endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["write"],"type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_998","description":"Customer's project id","required":true},{"name":"registrationId","in":"path","schemaId":"schema_1005","description":"Registration id requested","required":true},{"name":"attachmentId","in":"path","schemaId":"schema_1000","description":"Attachment definition id requested","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_1001"}},"schemaId":"schema_1001","pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/post/requestBody","description":"File content body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}","servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"eeew32344324edewe2e3","schemaId":"schema_998"},{"name":"registrationId","in":"path","required":true,"example":"234235425jhl21132424lf","schemaId":"schema_1005"},{"name":"attachmentId","in":"path","required":true,"example":"324234762423034240","schemaId":"schema_1000"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}}],"scopes":["write"]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_1001"}},"responseCodes":["200","400","404","413"],"pointer":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}","href":"registrations/uploadregistrationattachment","openApiOperationId":"uploadRegistrationAttachment","summary":"Upload attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"schemaId":"schema_1001","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_1001"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document uploaded successfully"},{"code":"400","description":"Registration status is not valid for including attachments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"404","description":"registration/document not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"},{"code":"413","description":"Document is too large to upload","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}},"schemaId":"components/schemas/RestError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1registrations~1{registrationId}~1attachments~1{attachmentId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"404","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}},{"code":"413","schemaId":"components/schemas/RestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/registrations/uploadregistrationattachment"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}"}],"content":{"contentType":"group","meta":{"name":"registrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Registrations","showPageActions":true},{"nodeType":"markdoc","content":"Submit, update, list and get registration info."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/registrations","summary":"List registrations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/registrations/listregistrations","deprecated":false},{"title":"/v1/projects/{projectId}/registrations","summary":"Submit registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/registrations/createregistration","deprecated":false},{"title":"/v1/projects/{projectId}/registrations/{registrationId}","summary":"Delete registration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/registrations/deleteregistration","deprecated":false},{"title":"/v1/projects/{projectId}/registrations/{registrationId}","summary":"Get registration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/registrations/getregistration","deprecated":false},{"title":"/v1/projects/{projectId}/registrations/{registrationId}","summary":"Update a registration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/registrations/updateregistration","deprecated":false},{"title":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}","summary":"Download previous attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/registrations/downloadregistrationattachment","deprecated":false},{"title":"/v1/projects/{projectId}/registrations/{registrationId}/attachments/{attachmentId}","summary":"Upload attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/registrations/uploadregistrationattachment","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"properties":{"attachmentId":{"description":"Unique identifier of the attachment.","example":"d1c7ccbf-919d-462f-8587-dec95a1b11ee","type":"string"},"createTime":{"description":"Create time of the request. ISO date time format in UTC without timezone offset.","example":"2021-11-03T14:30:03","type":"string"},"fileName":{"description":"Human readable name of the attachment.","example":"sender_id_registration_form.docx","type":"string"},"mimeType":{"description":"MIME type of the attachment file.","example":"application/vnd.openxmlformats-officedocument.wordprocessingml.document","type":"string"},"updateTime":{"description":"Update time of the request. ISO date time format in UTC without timezone offset.","example":"2021-11-03T14:30:03","type":"string"},"uploadStatus":{"description":"Status of the file uploaded","enum":["COMPLETED","WAITING","FAILED"],"x-enumDescriptions":{"COMPLETED":"Attachment successfully uploaded and linked to the registration","WAITING":"Attachment processing is still ongoing.","FAILED":"Attachment uploading has failed for any reason."},"example":"COMPLETED","type":"string"},"documentType":{"description":"Type of document attached.","example":"Passport","type":"string"}},"type":"object"}},"components/schemas/AttachmentDefinition":{"id":"components/schemas/AttachmentDefinition","kind":"json-schema","title":"AttachmentDefinition","data":{"properties":{"description":{"description":"Attachment description","example":"This document is required for any Third party registration in MK local.","type":"string"},"id":{"description":"Attachment Definition Id","example":"43342642354352344","type":"string"},"mandatory":{"description":"whether the attachment is mandatory in this policy","type":"boolean"},"template":{"description":"Whether the attachment contains a template or not. Templates can be downloaded with /template endpoint","type":"boolean"},"title":{"description":"Attachment title","example":"Third Party Authority Form","type":"string"},"allowedMimeTypes":{"description":"Array of allowed mime types. If empty, no restrictions are applied.","example":["application/pdf","application/pdf"],"type":"array","items":{"type":"string"}},"allowedDocumentTypes":{"description":"Document types allowed for this attachment. If specified, the documentType field in the attachment must be one of the allowed types.","example":["Passport","Driver's License"],"type":"array","items":{"type":"string"}}},"type":"object"}},"components/schemas/CallbackConfigurationResponse":{"id":"components/schemas/CallbackConfigurationResponse","kind":"json-schema","title":"CallbackConfigurationResponse","data":{"properties":{"hmacSecret":{"description":"The HMAC secret used for hashing the callback body using the HMAC-SHA1 algorithm - and for creating the X-Sinch-Signature header.","example":"d1c7ccbf-919d-462f-8587-dec95a1b11ee","type":"string"},"projectId":{"type":"string"}},"type":"object"}},"components/schemas/CallbackConfigurationUpdateBody":{"id":"components/schemas/CallbackConfigurationUpdateBody","kind":"json-schema","title":"CallbackConfigurationUpdateBody","data":{"properties":{"hmacSecret":{"description":"The HMAC secret to be updated for the specified project","example":"d1c7ccbf-919d-462f-8587-dec95a1b11ee","type":"string"}},"type":"object"}},"components/schemas/CallbackEventBody":{"id":"components/schemas/CallbackEventBody","kind":"json-schema","title":"CallbackEventBody","data":{"description":"Callback Event Object body","properties":{"comment":{"description":"Additional comment related to the latest status change","example":"Hi, the NOC letter contains phone numbers, and this is not allowed. Please have this updated to proceed forward. Regards, XX","type":"string"},"eventId":{"description":"The ID of the event.","example":"ee34ccbf-919d-462f-8587-dec95a1b11ee","type":"string"},"eventType":{"description":"The type of the event.","enum":["REGISTRATION_STATUS_CHANGE"],"x-enumDescriptions":{"REGISTRATION_STATUS_CHANGE":"Event informs about a registration status change."},"example":"REGISTRATION_STATUS_CHANGE","type":"string"},"projectId":{"description":"The ID of the project to which the event belongs.","example":"aad4ccbf-919d-462f-8587-dec95a1b11b0","type":"string"},"resourceId":{"description":"Corresponds to the registration id","example":"01hh51s80tpvjy7pe0mt6nd7at","type":"string"},"resourceType":{"description":"Type of the registration id","enum":["ALPHANUMERIC_SENDER_ID"],"x-enumDescriptions":{"ALPHANUMERIC_SENDER_ID":"Alpha sender IDs"},"example":"ALPHANUMERIC_SENDER_ID","type":"string"},"status":{"description":"The new status of the registration","enum":["IN_QUEUE","IN_PROGRESS","APPROVED","REJECTED","PENDING","ON_HOLD","PENDING_APPROVAL","PENDING_ATTACHMENTS"],"x-enumDescriptions":{"IN_QUEUE":"Registration has been successfully submitted, but it is waiting for support.","IN_PROGRESS":"Registration is being processing by Sinch.","APPROVED":"Registration has been approved and sender ID has been provisioned for the customer.","REJECTED":"Registration has been rejected. A comment should be present in the logs with the reason.","PENDING":"Registration must be updated by the customer. Please check the registration logs to understand the reason.","ON_HOLD":"Registration is on hold for any reason. Please check the comments in the logs.","PENDING_APPROVAL":"For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state.","PENDING_ATTACHMENTS":"Registration has been submitted, but at least one mandatory attachment must be provided."},"example":"IN_QUEUE","type":"string"},"timestamp":{"deprecated":true,"description":"The date and time when the callback was created and added to the callbacks queue. It's crucial to note that the callback service doesn't guarantee delivery order; hence, this timestamp serves as the source of truth for sequencing. This field is deprecated, please use createTime instead.","format":"date-time","example":"2023-06-06T07:45:27.785357Z","type":"string"},"createTime":{"description":"The date and time when the callback was created and added to the callbacks queue. It's crucial to note that the callback service doesn't guarantee delivery order; hence, this createTime serves as the source of truth for sequencing.","format":"date-time","example":"2023-06-06T07:45:27.785357Z","type":"string"},"senderIds":{"description":"List of sender IDs associated with this registration. If sender IDs are not provided in the request, they will be assigned after registration approval.","example":["senderId1","senderId2"],"type":"array","items":{"type":"string"}},"attachmentIds":{"description":"IDs of the attachments that were replaced or corrected by the review team and should be re-downloaded. Only present when the status change was caused by the review team requesting an update to a document.","example":["01m20g6mnrd9kpbdv3wwm8zfyy","01m21521k39d17a0atk05th8c8"],"type":"array","items":{"type":"string"}}},"type":"object"}},"components/schemas/ChainedSpecialCondition":{"id":"components/schemas/ChainedSpecialCondition","kind":"json-schema","title":"ChainedSpecialCondition","data":{"properties":{"answer":{"description":"Answer to previous question","example":"No","type":"string"},"description":{"example":"Promotional, marketing or advertising purposes","type":"string","description":"The Description field provides context or additional information to help users understand the purpose and usage of the Answer field."},"chainedSpecialConditions":{"description":"A chained special conditions that contains an answer of a previous question, a new question/answers if needed, a policy id if there are no more questions","items":{"$ref":"#/components/schemas/ChainedSpecialCondition"},"type":"array"},"policyId":{"description":"In markets without special conditions, the policy id is here. This field will be ignored (not exist) if there are chained special conditions","example":"43342642354352344","type":"string"},"prompt":{"description":"A question to be answered with the chained special conditions. This field will be ignored (not exist) if there are not chained special conditions","example":"Is this brand registered as a local legal entity in this market?","type":"string"}},"type":"object"}},"components/schemas/ErrorDetails":{"id":"components/schemas/ErrorDetails","kind":"json-schema","title":"ErrorDetails","data":{"type":"object"}},"components/schemas/GetRegistrationResponse":{"id":"components/schemas/GetRegistrationResponse","kind":"json-schema","title":"GetRegistrationResponse","data":{"description":"Registration content","properties":{"attachments":{"description":"Files attached to this registration","items":{"$ref":"#/components/schemas/Attachment"},"type":"array"},"callbackUrl":{"description":"Webhook URL to specify an endpoint for delivery of notifications about registration updates","example":"senderid.registrations.api.sinch.com","type":"string"},"createTime":{"description":"Creation time of the request. ISO date time format in UTC without timezone offset.","example":"2021-11-03T14:30:03","type":"string"},"etaDate":{"description":"Expected date of the registration approval. ISO date format.","example":"2024-11-03","type":"string"},"id":{"description":"Unique registration identifier.","example":"d1c7ccbf-919d-462f-8587-dec95a1b11ee","type":"string"},"logs":{"description":"Detailed history of the status changes this registration went through","items":{"$ref":"#/components/schemas/LogEntry"},"type":"array"},"notificationContacts":{"description":"Email addresses that will be notified of any status changes of the registration.","example":["jane.doe@example.com","john.doe@example.com"],"items":{"type":"string"},"type":"array"},"owner":{"description":"Display name of the user that created the registration.","example":"Jane Doe","type":"string"},"policyId":{"description":"Unique identifier of the policy for this registration.","example":"d1c7ccbf-919d-462f-8587-dec95a1b11ee","type":"string"},"price":{"$ref":"#/components/schemas/Pricing"},"registrationType":{"description":"Specify the sender ID type","enum":["ALPHANUMERIC_SENDER_ID","LONG_NUMBER","SHORT_CODE","RCS_AGENT"],"x-enumDescriptions":{"ALPHANUMERIC_SENDER_ID":"Alpha sender IDs","LONG_NUMBER":"Long Numbers for SMS","SHORT_CODE":"Short Codes for SMS","RCS_AGENT":"RCS agent"},"example":"ALPHANUMERIC_SENDER_ID","format":"enum","type":"string"},"requestDetails":{"description":"Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.","items":{"$ref":"#/components/schemas/RequestDetails"},"type":"array"},"senderIds":{"description":"List of sender IDs associated with this registration. If sender IDs are not provided in the request, they will be assigned after registration approval.","type":"array","items":{"type":"string"},"example":["senderId1","senderId2"]},"status":{"description":"Status of the registration.","enum":["DRAFT","IN_QUEUE","IN_PROGRESS","APPROVED","REJECTED","PENDING","ON_HOLD","PENDING_APPROVAL","PENDING_ATTACHMENTS"],"x-enumDescriptions":{"DRAFT":"Registration not submitted by the customer. This functionality is not available through Public API, but it is possible to retrieve a registration created in the Sinch Customer Dashboard under the same project Id.","IN_QUEUE":"Registration has been successfully submitted, but it is waiting for support.","IN_PROGRESS":"Registration is being processing by Sinch.","APPROVED":"Registration has been approved and sender ID has been provisioned for the customer.","REJECTED":"Registration has been rejected. A comment should be present in the logs with the reason.","PENDING":"Registration must be updated by the customer. Please check the registration logs to understand the reason.","ON_HOLD":"Registration is on hold for any reason. Please check the comments in the logs.","PENDING_APPROVAL":"For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state.","PENDING_ATTACHMENTS":"Registration has been submitted, but at least one mandatory attachment must be provided."},"example":"IN_QUEUE","type":"string"},"tags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes."},"children":[]}]}]}],"example":["#myTag1","#myTag2"],"items":{"type":"string"},"type":"array"},"updateTime":{"description":"Update time of the request. ISO date time format in UTC without timezone offset.","example":"2021-11-03T14:30:03","type":"string"},"servicePlanId":{"example":"a23dccbf-919d-462f-8587-dec95a1b44de","type":"string","description":"Service plan ID or System ID that the registration applies to. When included, the sender id will be configured linked to the service/system plan."}},"type":"object"}},"components/schemas/InternalRestError":{"id":"components/schemas/InternalRestError","kind":"json-schema","title":"InternalRestError","data":{"properties":{"code":{"format":"int32","type":"integer"},"details":{"items":{"$ref":"#/components/schemas/ErrorDetails"},"type":"array"},"message":{"type":"string"},"status":{"type":"string"}},"type":"object"}},"components/schemas/ListAvailableMarketsResponse":{"id":"components/schemas/ListAvailableMarketsResponse","kind":"json-schema","title":"ListAvailableMarketsResponse","data":{"description":"List of market codes available for registration under request filters.","properties":{"markets":{"description":"List of countries that matches with the request criteria.","items":{"$ref":"#/components/schemas/MarketDescription"},"type":"array"}},"type":"object"}},"components/schemas/ListMarketVersionsResponse":{"id":"components/schemas/ListMarketVersionsResponse","kind":"json-schema","title":"ListMarketVersionsResponse","data":{"properties":{"marketVersions":{"description":"List of Market versions that matches with the request criteria.","items":{"$ref":"#/components/schemas/MarketVersion"},"type":"array"},"nextPageToken":{"description":"next token to be used to retrieve more markets","example":"CgptYXJrZXRDb2RlEk4KRnR5cGUuZ29vZ2xlYXBpcy5jb20vc2luY2gubnVtcmVnLnBvbGljeS52MWFscGhhMi5NYXJrZXRWZXJzaW9uUGFnZU1hcmsSBAoCS1o=","type":"string"},"totalSize":{"description":"Total Number of markets.","example":50,"format":"int32","type":"integer"}},"type":"object"}},"components/schemas/ListRegistrationsResponse":{"id":"components/schemas/ListRegistrationsResponse","kind":"json-schema","title":"ListRegistrationsResponse","data":{"properties":{"nextPageToken":{"description":"Page token that can be used to retrieve next page of registrations if they exist. Will be empty if next page does not exist","type":"string"},"registrations":{"description":"List of registrations","items":{"$ref":"#/components/schemas/GetRegistrationResponse"},"type":"array"},"totalSize":{"description":"Total count of registrations matching provided search criteria","format":"int32","type":"integer"}},"type":"object"}},"components/schemas/LogEntry":{"id":"components/schemas/LogEntry","kind":"json-schema","title":"LogEntry","data":{"properties":{"createTime":{"description":"Create time of this log entry. ISO date time format in UTC","example":"2021-11-03T14:30:03","type":"string"},"message":{"description":"Optional message with details of the registration status update. Can contain information provided by the agent handling the request.","example":"Please update the attachment connected to your request.","type":"string"},"registrationState":{"description":"State of the registration after this entry was created","example":"PENDING","type":"string"}},"type":"object"}},"components/schemas/MarketDescription":{"id":"components/schemas/MarketDescription","kind":"json-schema","title":"MarketDescription","data":{"description":"Market description contains for each market, the market name and the market ISO Code (2 characters)","properties":{"marketCode":{"description":"ISO market code (ex. 'IT', 'AU', 'AE', etc.)","example":"AE","pattern":"^[A-Z]{2}$","type":"string"},"marketName":{"description":"Market Name","example":"United Arab Emirates","type":"string"}},"type":"object"}},"components/schemas/MarketVersion":{"id":"components/schemas/MarketVersion","kind":"json-schema","title":"MarketVersion","data":{"description":"Each Market Version object contains id, market code, registration type, market status and a set of special conditions.","properties":{"createTime":{"description":"Creation time of this major/minor market version.","example":"2023-09-17 06:22:34.372747","format":"date-time","type":"string"},"id":{"description":"Market Version Id.","example":"ddede333432ededed2","type":"string"},"majorVersion":{"description":"Major version of the policy. Indicates market requirement changes that may require resubmitting requests in progress.","example":1,"format":"int32","type":"integer"},"marketCode":{"description":"ISO country code.","example":"AU","type":"string"},"minorVersion":{"description":"Minor version of the policy. Indicates market requirement changes that do not require resubmitting requests in progress.","example":0,"format":"int32","type":"integer"},"registrationType":{"description":"Type of Sender ID referenced by this market.","enum":["ALPHANUMERIC_SENDER_ID","LONG_NUMBER","SHORT_CODE","RCS_AGENT"],"x-enumDescriptions":{"ALPHANUMERIC_SENDER_ID":"Alpha sender IDs","LONG_NUMBER":"Long Numbers for SMS","SHORT_CODE":"Short Codes for SMS","RCS_AGENT":"RCS agent"},"example":"ALPHANUMERIC_SENDER_ID","format":"enum","type":"string"},"specialConditions":{"$ref":"#/components/schemas/SpecialCondition"},"status":{"description":"Market status, it can be active or disabled","enum":["ACTIVE","DISABLED"],"x-enumDescriptions":{"ACTIVE":"Market is available to request sender IDs.","DISABLED":"Market has been deactivated and sender IDs cannot be requested."},"example":"ACTIVE","format":"enum","type":"string"}},"type":"object"}},"components/schemas/Policy":{"id":"components/schemas/Policy","kind":"json-schema","title":"Policy","data":{"description":"Policy response, contains the fields and attachments required, multi type configuration, status and fees","properties":{"attachments":{"description":"Attachment Definition","items":{"$ref":"#/components/schemas/AttachmentDefinition"},"type":"array"},"fees":{"deprecated":true,"description":"True if policy registration has any fees associated","type":"boolean"},"id":{"description":"Policy Version Id","example":"43342642354352344","type":"string"},"jsonPolicy":{"$ref":"#/components/schemas/Policy_JsonPolicy"},"policyMultiType":{"description":"Indicates whether the policy accepts single or multi sender id requested in each registration process","enum":["SINGLE","MULTI_SENDER"],"x-enumDescriptions":{"SINGLE":"Only one sender ID is allowed per registration.","MULTI_SENDER":"Up to 50 sender IDs are allowed per registration. They can be included in the senderIdDetails array (one object per sender ID)"},"example":"SINGLE","format":"enum","type":"string"},"policyStatus":{"description":"Policy status","enum":["ENABLED","DISABLED","INACTIVE"],"x-enumDescriptions":{"ENABLED":"Policy is in use.","DISABLED":"Policies that for any reason has been deactivated. There are several reasons to do so, but they are mainly due to changes in the regulations, which require some manual intervention.","INACTIVE":"Market version has been deactivated because a new version has been published. This policy is no longer valid."},"example":"ENABLED","format":"enum","type":"string"},"price":{"$ref":"#/components/schemas/Policy_Pricing"},"isOpenPolicy":{"description":"Indicates if the policy has open registration system. This means that any sender ID requested is automatically approved, without any manual intervention.","type":"boolean"},"statusDisclaimer":{"description":"Contains disclaimer for disabled policies. Empty if policy is ACTIVE","example":"Policy has been disabled as Registrations for these market conditions are now dynamic.","type":"string"}},"type":"object"}},"components/schemas/Policy_JsonPolicy":{"id":"components/schemas/Policy_JsonPolicy","kind":"json-schema","title":"Policy_JsonPolicy","data":{"properties":{"companyDetailsTemplate":{"description":"Policy section related to company details","properties":{"properties":{"items":{"$ref":"#/components/schemas/Policy_JsonPolicy_Property"},"type":"array"}},"type":"object"},"contactPersonTemplate":{"description":"Policy section related to contact person details","properties":{"properties":{"items":{"$ref":"#/components/schemas/Policy_JsonPolicy_Property"},"type":"array"}},"type":"object"},"senderIdTemplate":{"description":"Policy section related to sender ID details","properties":{"properties":{"items":{"$ref":"#/components/schemas/Policy_JsonPolicy_Property"},"type":"array"}},"type":"object"},"marketSpecificDetailsTemplate":{"description":"Only available for RCS Agent policies. This section shows some market specific requirements, while others are general for all markets.","properties":{"properties":{"items":{"$ref":"#/components/schemas/Policy_JsonPolicy_Property"},"type":"array"}},"type":"object"}},"type":"object"}},"components/schemas/Policy_JsonPolicy_Property":{"id":"components/schemas/Policy_JsonPolicy_Property","kind":"json-schema","title":"Policy_JsonPolicy_Property","data":{"description":"Object with fields properties containing field rules and description","properties":{"description":{"description":"Description of the field","example":"Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.","type":"string"},"x-placeholder":{"description":"Placeholder text shown in the field when it is empty. An example of what should be entered in the field","example":"e.g. name.surname@yourCompany.com","type":"string"},"maxLength":{"description":"Max length of text field","example":11,"type":"integer"},"minLength":{"description":"Min length of text field","example":3,"type":"integer"},"name":{"description":"Name of the field. Serves as a key (reference) to a field","example":"senderId","type":"string"},"required":{"description":"Indicator that specifies whether a field is optional or required","example":false,"type":"boolean"},"title":{"description":"Name of field shown in user interface. In some cases, there is a question for which an answer is expected in the field","example":"Alphanumeric Sender ID","type":"string"},"type":{"description":"Type of field. Possible types are 'string' - for a simple text field or enum or 'array' - for multiple texts in one field","example":"string","type":"string","enum":["string","array"],"x-enumDescriptions":{"string":"Field value expected is an string value","array":"Field value expected is an array of values. In this case, the items are described in field 'items'"}},"examples":{"description":"Used as suggestions for possible response in the field","example":["By subscribing to our loyalty program","By making a purchase in-store or online"],"type":"array","items":{"type":"string"}},"pattern":{"description":"Regex pattern validation","example":"^[+][0-9]+$","type":"string"},"message":{"description":"Pattern validation message","properties":{"pattern":{"description":"Pattern validation message","example":"The number needs to start with country code. For example +1","type":"string"},"maxLength":{"description":"Max length of the field value","example":11,"type":"integer"},"minLength":{"description":"Min length of the field value","example":3,"type":"integer"}},"type":"object"},"items":{"description":"When the field type is 'array', this object describes the array items. Typically a checkbox. Contains an enum when the array items are restricted to a set of values.","properties":{"enum":{"description":"Possible values for the array items","oneOf":[{"type":"array","items":{"type":"string","example":"+1"}},{"type":"array","items":{"type":"integer","example":44}}]},"type":{"description":"Type of the array items. Possible types are 'string' or 'integer'","example":"string","type":"string","enum":["string","integer"],"x-enumDescriptions":{"string":"Text array items","integer":"Numeric array items"}}},"type":"object"},"minItems":{"description":"Minimum number of items selected when the field type is 'array'","example":1,"type":"integer"},"enum":{"description":"Possible values for the field when the field type is not an array. Typically a dropdown. In some cases the enum contains true and null. This is for mandatory checks according to market regulations.","oneOf":[{"type":"array","items":{"type":"string","example":"By subscribing to our loyalty program"}},{"type":"array","items":{"type":"integer","example":3}},{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be a true false option or a true checkbox, that contains [true, null] as options"},"children":[]}]}]}],"items":{"type":"boolean","example":true}}]}},"type":"object"}},"components/schemas/Policy_Pricing":{"id":"components/schemas/Policy_Pricing","kind":"json-schema","title":"Policy_Pricing","data":{"properties":{"mode":{"description":"Type of policy pricing.","enum":["SUBSCRIBED","MANUAL","NONE"],"x-enumDescriptions":{"SUBSCRIBED":"policy which has automatic fees assigned: setup fee or/and recurrent fee","MANUAL":"policy contains fees associated in the market, those are managed and approved by customer's account manager","NONE":"no fee associated"},"example":"SUBSCRIBED","format":"enum","type":"string"},"subscription":{"$ref":"#/components/schemas/Pricing_Subscription"}},"type":"object"}},"components/schemas/Pricing":{"id":"components/schemas/Pricing","kind":"json-schema","title":"Pricing","data":{"properties":{"currency":{"description":"Currency of the fees","example":"USD","type":"string"},"frequency":{"description":"Recurrent subscription period in month, 0 if no subscription fees","example":1,"format":"int32","type":"integer"},"mode":{"description":"Type of policy pricing.","enum":["SUBSCRIBED","MANUAL","NONE"],"x-enumDescriptions":{"SUBSCRIBED":"policy which has automatic fees assigned: setup fee or/and recurrent fee","MANUAL":"policy contains fees associated in the market, those are managed and approved by customer's account manager","NONE":"no fee associated"},"example":"SUBSCRIBED","format":"enum","type":"string"},"recurrentFeeAmount":{"description":"Recurrent subscription fee amount","example":"2","type":"string"},"setupFeeAmount":{"description":"One time setup fee amount","example":"5","type":"string"}},"type":"object"}},"components/schemas/Pricing_Subscription":{"id":"components/schemas/Pricing_Subscription","kind":"json-schema","title":"Pricing_Subscription","data":{"properties":{"currency":{"description":"Currency of user","type":"string"},"frequency":{"description":"Frequency of recurrent fee, is 0 when there is not recurrent fee. The number ranges from 0 to 12, where 1 indicates monthly payments and 12 indicates yearly payments","format":"int32","type":"integer"},"recurrentFeeAmount":{"description":"Amount of recurrent fee","type":"string"},"setupFeeAmount":{"description":"Amount of setup fee","type":"string"}},"type":"object"}},"components/schemas/RegistrationCreateBody":{"id":"components/schemas/RegistrationCreateBody","kind":"json-schema","title":"RegistrationCreateBody","data":{"properties":{"callbackUrl":{"description":"Webhook URL to specify an endpoint for delivery of notifications about registration updates","example":"senderid.registrations.api.sinch.com","type":"string"},"notificationContacts":{"description":"Email addresses that will be notified of any status changes of the registration.","example":["jane.doe@example.com","john.doe@example.com"],"items":{"type":"string"},"type":"array"},"policyId":{"description":"Policy id that applies the registration.","example":"d1c7ccbf-919d-462f-8587-dec95a1b11ee","type":"string"},"requestDetails":{"description":"Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.","items":{"$ref":"#/components/schemas/RequestDetails"},"type":"array"},"tags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes."},"children":[]}]}]}],"example":["#myTag1","#myTag2"],"items":{"type":"string"},"type":"array"},"servicePlanId":{"example":"a23dccbf-919d-462f-8587-dec95a1b44de","type":"string","description":"Service plan ID or System ID that the registration applies to. When included, the sender id will be configured linked to the service/system plan."}},"type":"object"}},"components/schemas/RegistrationUpdateBody":{"id":"components/schemas/RegistrationUpdateBody","kind":"json-schema","title":"RegistrationUpdateBody","data":{"properties":{"callbackUrl":{"description":"Webhook URL to specify an endpoint for delivery of notifications about registration updates","example":"senderid.registrations.api.sinch.com","type":"string"},"notificationContacts":{"description":"Email addresses that will be notified of any status changes of the registration.","example":["jane.doe@example.com","john.doe@example.com"],"items":{"type":"string"},"type":"array"},"requestDetails":{"description":"Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.","items":{"$ref":"#/components/schemas/RequestDetails"},"type":"array"},"tags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes."},"children":[]}]}]}],"example":["#myTag1","#myTag2"],"items":{"type":"string"},"type":"array"},"servicePlanId":{"example":"a23dccbf-919d-462f-8587-dec95a1b44de","type":"string","description":"Service plan ID or System ID that the registration applies to. When included, the sender id will be configured linked to the service/system plan."}},"type":"object"}},"components/schemas/RequestDetails":{"id":"components/schemas/RequestDetails","kind":"json-schema","title":"RequestDetails","data":{"properties":{"additionalDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details required for this registration, e.g. company details, contact information or market specific details (only in RCS). Schema and content depend on the specific market requirements defined in the policy Json format is '{key:value, key:value}' with types like string, array, array of objects"},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"email":"email@mycompany.com"},{"companyName":"My Company Name","website":"https://www.mycompany.com"}]},"senderIdDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data related to the sender ID values requested in this registration. Schema and content depend on the specific market requirements defined in the policy. Json format is '{key:value, key:value}' with types like string, array, array of objects"},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"sender":"a sender value"}]}},"type":"object"}},"components/schemas/RestError":{"id":"components/schemas/RestError","kind":"json-schema","title":"RestError","data":{"properties":{"error":{"$ref":"#/components/schemas/InternalRestError"}},"type":"object"}},"components/schemas/SpecialCondition":{"id":"components/schemas/SpecialCondition","kind":"json-schema","title":"SpecialCondition","data":{"properties":{"chainedSpecialConditions":{"description":"A chained special conditions that contains an answer of a previous question, a new question/answers if needed, a policy id if there are no more questions","items":{"$ref":"#/components/schemas/ChainedSpecialCondition"},"type":"array"},"policyId":{"description":"In markets without special conditions, the policy id is here. This field will be ignored (not exist) if there are chained special conditions","example":"43342642354352344","type":"string"},"prompt":{"description":"A question to be answered with the chained special conditions. This field will be ignored (not exist) if there are not chained special conditions","example":"Is this brand registered as a local legal entity in this market?","type":"string"}},"type":"object"}},"schema_992":{"kind":"json-schema","data":{"type":"string"},"id":"schema_992"},"schema_993":{"kind":"json-schema","data":{"type":"string","pattern":"^[A-Z]{2}$"},"id":"schema_993"},"schema_994":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-z]{2}$"},"id":"schema_994"},"schema_995":{"kind":"json-schema","data":{"format":"enum","type":"string","enum":["ALPHANUMERIC_SENDER_ID","LONG_NUMBER","SHORT_CODE","RCS_AGENT"],"x-enumDescriptions":{"ALPHANUMERIC_SENDER_ID":"Alpha sender IDs","LONG_NUMBER":"Long Numbers for SMS","SHORT_CODE":"Short Codes for SMS","RCS_AGENT":"RCS agent"},"default":"ALPHANUMERIC_SENDER_ID"},"id":"schema_995"},"schema_996":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_996"},"schema_997":{"kind":"json-schema","data":{"format":"int32","type":"integer"},"id":"schema_997"},"schema_998":{"kind":"json-schema","data":{"example":"eeew32344324edewe2e3","type":"string"},"id":"schema_998"},"schema_999":{"kind":"json-schema","data":{"example":"43342642354352344","type":"string"},"id":"schema_999"},"schema_1000":{"kind":"json-schema","data":{"example":"324234762423034240","type":"string"},"id":"schema_1000"},"schema_1001":{"kind":"json-schema","data":{"format":"binary","type":"string"},"id":"schema_1001"},"schema_1002":{"kind":"json-schema","data":{"type":"string","enum":["DRAFT","IN_QUEUE","IN_PROGRESS","APPROVED","REJECTED","PENDING","ON_HOLD","PENDING_APPROVAL","PENDING_ATTACHMENTS"],"x-enumDescriptions":{"DRAFT":"Registration not submitted by the customer. This functionality is not available through Public API, but it is possible to retrieve a registration created in the Sinch Customer Dashboard under the same project Id.","IN_QUEUE":"Registration has been successfully submitted, but it is waiting for support.","IN_PROGRESS":"Registration is being processing by Sinch.","APPROVED":"Registration has been approved and sender ID has been provisioned for the customer.","REJECTED":"Registration has been rejected. A comment should be present in the logs with the reason.","PENDING":"Registration must be updated by the customer. Please check the registration logs to understand the reason.","ON_HOLD":"Registration is on hold for any reason. Please check the comments in the logs.","PENDING_APPROVAL":"For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state.","PENDING_ATTACHMENTS":"Registration has been submitted, but at least one mandatory attachment must be provided."}},"id":"schema_1002"},"schema_1003":{"kind":"json-schema","data":{"items":{"type":"string"},"type":"array"},"id":"schema_1003"},"schema_1004":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CallbackEventBody"},"id":"schema_1004"},"schema_1005":{"kind":"json-schema","data":{"example":"234235425jhl21132424lf","type":"string"},"id":"schema_1005"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","description":"The username and password are your Key ID and Key Secret from the Access keys section in the Sinch Customer Dashboard. Exchange these for a bearer token (access token).","flows":{"clientCredentials":{"scopes":{"read":"read","write":"write"},"tokenUrl":"https://auth.sinch.com/oauth2/token"}}},"hmacAuth":{"id":"hmacAuth","type":"http","scheme":"hmac","description":"Used for hashing callbacks. Please refer to the callback-configuration endpoints for more information."}},"servers":[{"url":"https://senderid.registrations.api.sinch.com","description":"Production server"},{"url":"https://senderid.numbers-registration.staging.sinch.com","description":"Staging server"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/registration-api/api-reference/registrations","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/registration-api/api-reference/registrations.json?download"},{"url":"/_bundle/docs/registration-api/api-reference/registrations.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Sinch Sender ID Registrations API","description":"This API describes the set of endpoints available to get each market requirements and create registration for sender IDs.\n\nThe list of endpoints allows to create, update and delete a registration and also get the current state.\nFor each market, customers can check the different requirements depending on the new sender ID scope, and also download templates to fill in for the registrations.\n\nInterested in this API? Please, reach out to your Account Manager for more info. "}},"baseSlug":"/docs/registration-api/api-reference/registrations","routesMapping":{}}