{"items":[{"type":"link","label":"Number Lookup Api v1","link":"/docs/number-lookup-api/api-reference/number-lookup","routeSlug":"/docs/number-lookup-api/api-reference/number-lookup","content":{"contentType":"overview","meta":{"name":"Number Lookup Api v1"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"number-lookup.json","url":"/_bundle/docs/number-lookup-api/api-reference/number-lookup.json?download"},{"kind":"download","label":"number-lookup.yaml","url":"/_bundle/docs/number-lookup-api/api-reference/number-lookup.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.sinch.com/contact-us/","url":"https://www.sinch.com/contact-us/"},{"kind":"email","title":"Sinch","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":[{"url":"https://number-lookup.api.sinch.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Number Lookup Api v1 (0.1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is public api specification, for number lookup product."}],"sectionId":"/docs/number-lookup-api/api-reference/number-lookup"}],"sectionId":"/docs/number-lookup-api/api-reference/number-lookup"}]}]}},{"type":"group","label":"NumberLookup","link":"/docs/number-lookup-api/api-reference/number-lookup/numberlookup","routeSlug":"/docs/number-lookup-api/api-reference/number-lookup/numberlookup","items":[{"label":"Performs a number lookup.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/number-lookup-api/api-reference/number-lookup/numberlookup/numberlookup_lookup","routeSlug":"/docs/number-lookup-api/api-reference/number-lookup/numberlookup/numberlookup_lookup","metadata":{"seo":{"title":"Performs a number lookup.","description":"Performs a number lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberLookup_Lookup","name":"Performs a number lookup.","isWebhook":false,"pointer":"/paths/~1v1~1lookups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Performs a number lookup.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/number-lookup-api-v2/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"Application","scopes":[],"type":"apiKey","in":"header","paramName":"Authentication","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/number-lookup-api-v2/api-reference/authentication/signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NumberLookupRequest"}},"schemaId":"components/schemas/NumberLookupRequest","pointer":"/paths/~1v1~1lookups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/lookups","servers":[{"url":"https://number-lookup.api.sinch.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"Application","type":"apiKey","name":"Authentication","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NumberLookupRequest"}},"responseCodes":["200","400","401","402","403","404","429","500"],"pointer":"/v1/lookups","href":"numberlookup/numberlookup_lookup","openApiOperationId":"NumberLookup_Lookup","summary":"Performs a number lookup.","securityGroups":[{"Basic":[]},{"Application":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://number-lookup.api.sinch.com"}],"schemaId":"components/schemas/NumberLookupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NumberLookupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberLookupResponse"}},"schemaId":"components/schemas/NumberLookupResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Invalid Authorization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"402","description":"Account Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":"API disabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"500","description":"Internal Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v1~1lookups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NumberLookupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberLookupResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"402","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"429","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/numberlookup/numberlookup_lookup"}],"panels":[]}]},"httpPath":"/v1/lookups"}],"content":{"contentType":"group","meta":{"name":"NumberLookup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NumberLookup","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/lookups","summary":"Performs a number lookup.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/numberlookup/numberlookup_lookup","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/NumberLookupResponse":{"id":"components/schemas/NumberLookupResponse","kind":"json-schema","title":"NumberLookupResponse","data":{"type":"object","additionalProperties":false,"properties":{"line":{"description":"An object containing information about the line type of the number.","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/LineResponse"}]},"simSwap":{"description":"An object containing information about the SimSwap verification performed on the number.","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/SimSwapResponse"}]},"voIPDetection":{"description":"An object containing information about the VoIP detection performed on the number.","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/VoIPDetectionResponse"}]},"rnd":{"description":"An object containing information whether number is disconnected.","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/RndResponse"}]},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 two-letter country identifier"},"traceId":{"type":"string","description":"The identifier for a trace.","example":"84c1fd4063c38d9f3900d06e56542d48"},"number":{"type":"string","description":"Requested MSISDN in E.164 format.","example":"+12312312312"}}}},"components/schemas/LineResponse":{"id":"components/schemas/LineResponse","kind":"json-schema","title":"LineResponse","data":{"type":"object","additionalProperties":false,"properties":{"carrier":{"type":"string","description":"Name of the carrier.","nullable":true,"example":"T-Mobile USA"},"type":{"description":"Number type e.g. wireless, mobile, fixed.","type":"string","nullable":true,"example":"Mobile","allOf":[{"$ref":"#/components/schemas/ApiLineType"}]},"mobileCountryCode":{"type":"string","description":"A numeric code (MCC) that uniquely identifies a country within the international telecommunications network.","nullable":true,"example":"310"},"mobileNetworkCode":{"type":"string","description":"A distinct identifier assigned to a mobile network operator within a specific country, used in combination with MCC.","nullable":true,"example":"260"},"ported":{"type":"boolean","description":"Indicates if a phone number has been transferred from its original network to a different provider.","nullable":true,"example":true},"portingDate":{"type":"string","description":"Specifies the date, in ISO 8601 format, when a phone number was transferred from its original network to a new provider.","nullable":true,"example":"2000-01-01 00:00:00+00:00"},"error":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]}}}},"components/schemas/ApiLineType":{"id":"components/schemas/ApiLineType","kind":"json-schema","title":"ApiLineType","data":{"type":"string","description":"Represents the type of a phone line.","x-enumNames":["Landline","Mobile","VoIP","Special","Freephone","Other"],"enum":["Landline","Mobile","VoIP","Special","Freephone","Other"],"x-enumDescriptions":{"Landline":"A landline phone number.","Mobile":"A mobile network phone number.","VoIP":"A Voice over IP phone number.","Special":"A specialty type of number, such as a satellite phone or fax line.","Freephone":"A freephone type phone number.","Other":"Another type."}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"integer","description":"The error status code.","format":"int32"},"title":{"type":"string","description":"A short, human-readable summary of the error type."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the error."},"type":{"type":"string","description":"A URI reference that identifies the error type.","nullable":true}}}},"components/schemas/SimSwapResponse":{"id":"components/schemas/SimSwapResponse","kind":"json-schema","title":"SimSwapResponse","data":{"type":"object","additionalProperties":false,"properties":{"swapped":{"type":"boolean","description":"Indicates whether SIM was changed.","nullable":true,"example":true},"swapPeriod":{"description":"Threshold for sim swap check.","type":"string","nullable":true,"example":"SP24H","allOf":[{"$ref":"#/components/schemas/ApiSwapPeriod"}]},"error":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]}}}},"components/schemas/ApiSwapPeriod":{"id":"components/schemas/ApiSwapPeriod","kind":"json-schema","title":"ApiSwapPeriod","data":{"type":"string","description":"","x-enumNames":["Undefined","SP4H","SP12H","SP24H","SP48H","SP5D","SP7D","SP14D","SP30D","SPMAX"],"enum":["Undefined","SP4H","SP12H","SP24H","SP48H","SP5D","SP7D","SP14D","SP30D","SPMAX"],"x-enumDescriptions":{"Undefined":"Undefined","SP4H":"4 Hours","SP12H":"12 Hours","SP24H":"24 Hours","SP48H":"48 Hours","SP5D":"5 Days","SP7D":"7 Days","SP14D":"14 Days","SP30D":"30 Days","SPMAX":"Maximum"}}},"components/schemas/VoIPDetectionResponse":{"id":"components/schemas/VoIPDetectionResponse","kind":"json-schema","title":"VoIPDetectionResponse","data":{"type":"object","additionalProperties":false,"properties":{"probability":{"description":"Probability of number being VoIP based on the AI analysis.","type":"string","nullable":true,"example":"High","allOf":[{"$ref":"#/components/schemas/ApiVoIPProbability"}]},"error":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]}}}},"components/schemas/ApiVoIPProbability":{"id":"components/schemas/ApiVoIPProbability","kind":"json-schema","title":"ApiVoIPProbability","data":{"type":"string","description":"","x-enumNames":["Unknown","Low","Likely","High"],"enum":["Unknown","Low","Likely","High"],"x-enumDescriptions":{"Unknown":"Undefined","Low":"Low","Likely":"Likely","High":"High"}}},"components/schemas/RndResponse":{"id":"components/schemas/RndResponse","kind":"json-schema","title":"RndResponse","data":{"type":"object","additionalProperties":false,"properties":{"disconnected":{"type":"boolean","description":"Provides information whether the number was disconnected after provided last contact date.","nullable":true},"error":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/ErrorResponse"}]}}}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type.","nullable":true},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"traceId":{"type":"string","description":"The identifier for a trace.","example":"00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"}}}},"components/schemas/NumberLookupRequest":{"id":"components/schemas/NumberLookupRequest","kind":"json-schema","title":"NumberLookupRequest","data":{"type":"object","additionalProperties":false,"required":["number"],"properties":{"number":{"type":"string","description":"MSISDN in E.164 format to query.","minLength":1,"example":"+12312312312"},"features":{"type":"array","description":"Contains requested features. Fallback to LineType if not provided.","items":{"$ref":"#/components/schemas/ApiFeature"}},"rndFeatureOptions":{"description":"Required when RND feature is requested.","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/RndFeatureOptions"}]}}}},"components/schemas/ApiFeature":{"id":"components/schemas/ApiFeature","kind":"json-schema","title":"ApiFeature","data":{"type":"string","description":"","x-enumNames":["LineType","SimSwap","VoIPDetection","RND"],"enum":["LineType","SimSwap","VoIPDetection","RND"],"x-enumDescriptions":{"LineType":"LineType","SimSwap":"SimSwap","VoIPDetection":"VoIPDetection (alpha).","RND":"RND (alpha)."}}},"components/schemas/RndFeatureOptions":{"id":"components/schemas/RndFeatureOptions","kind":"json-schema","title":"RndFeatureOptions","data":{"type":"object","additionalProperties":false,"properties":{"contactDate":{"type":"string","description":"Last contact date in YYYY-MM-DD format.","format":"date"}}}}},"exampleStore":{},"securitySchemeStore":{"Basic":{"id":"Basic","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about basic authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/number-lookup-api-v2/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Application":{"id":"Application","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about application request signing authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/number-lookup-api-v2/api-reference/authentication/signed-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Signing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authentication"}},"servers":[{"url":"https://number-lookup.api.sinch.com"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/number-lookup-api/api-reference/number-lookup","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/number-lookup-api/api-reference/number-lookup.json?download"},{"url":"/_bundle/docs/number-lookup-api/api-reference/number-lookup.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Number Lookup Api v1","description":"This is public api specification, for number lookup product."}},"baseSlug":"/docs/number-lookup-api/api-reference/number-lookup","routesMapping":{}}