{"openapi":"3.0.1","info":{"title":"Third Party API Service ","description":"Third Party API  is a microservice which exposes below services.\nThe Email Verification API validates your email addresses to protect your database from invalid, toxic and undesirable email addresses. We help you avoid a damaged sender reputations by flagging those bouncing emails, spam trap hits, honeypots, stale lists and do-not-contact list before you have a chance to use them.\nThe Phone Verification API validates your phone numbers to protect your database from invalid, toxic and undesirable phone numbers. We help you avoid a damaged sender reputation by flagging those invalid phone numbers and do-not-contact list before you have a chance to use them.\nThe Geolocation SAAS offers Geolocation services to get the com.precisely.geolocation by IP address, WiFi access point.\n\n\n<details>\n    <summary>Error Codes</summary>\n\nAPIs will return the following error codes in case of any error:\n\n\n| Error Code                 | Description\n|----------------------------|-------------------------------------------------------\n|DIS-1001                   |Unauthorized, Invalid token\n|DIS-1002                   |Not Authorized to access this API\n|DIS-1003                   |Issue with internal services\n|DIS-1004                   |Workspace Id is missing from Bearer Token\n|DIS-1005                   |Rate limit exceeded\n|DIS-1006                   |Unauthorized, Invalid key/secret\n|DIS-1008                   |Invalid request ID, maximum allowed length is 38 characters\n|DIS-1009                   |Access blocked due to too many failed attempts. Please try again after sometime\n|DIS-1010                   |Workspace has been expired\n|DIS-EV-1001                |Batch size must not exceed 10\n|DIS-EV-1002                |Email can not be null or empty\n|DIS-EV-1003                |Request is not valid\n|DIS-EV-1004                |Required body is not specified\n\n</details>\n","version":"1.0"},"servers":[{"url":"https://api.cloud.precisely.com"},{"url":"https://api.eu1.cloud.precisely.com"},{"url":"https://api.au1.cloud.precisely.com"},{"url":"https://api.gb1.cloud.precisely.com"}],"tags":[{"name":"Geolocation","description":"Operations related to Geolocation lookup"},{"name":"Email Verification","description":"Operations related to Email Verification"},{"name":"Phone Verification","description":"Operations related to Phone Verification"},{"name":"BankValidation","description":"Operations related to Bank Validation"}],"paths":{"/v1/banks/iban-structure":{"get":{"tags":["BankValidation"],"summary":"Returns IBAN/BBAN structure for a country","description":"Returns the IBAN length and BBAN structure for a given ISO 3166-1 alpha-2 country code.\n","operationId":"getStructure","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"e8a838ca-14bf-4f0b-b29e-1ed2515b0772"},{"name":"countryIso2","in":"query","description":"ISO 3166-1 alpha-2 country code","required":true,"schema":{"type":"string"},"example":"GB"}],"responses":{"200":{"description":"IBAN structure retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureApiResponse"},"examples":{"example":{"value":{"response":{"status":"OK","result":{"countryIso2":"GB","ibanLength":22,"bbanStructure":[{"partType":"bank_code","length":4,"characterType":"n"},{"partType":"sort_code","length":6,"characterType":"n"},{"partType":"account_number","length":8,"characterType":"n"}]}}}}}}}},"400":{"description":"Invalid or unsupported country code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"6900b63d72d75452c6c982afef49dc70","errors":[{"code":"DIS-BAV-1001","detail":"Invalid or unsupported country code"}]}}}}}},"401":{"description":"Unauthorized: Invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"0049c2dbb58b8393e8bced346fd8d660","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"422":{"description":"IBAN is not supported for this country","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7a00b63d72d75452c6c982afef49dc71","errors":[{"code":"DIS-BAV-1002","detail":"IBAN is not supported for country"}]}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"f287c3b95d11f9ff28472ccc9ff38929","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/emails/verify":{"post":{"tags":["Email Verification"],"summary":"Performs single email verification","description":"This endpoint is for single email verification.\n\n","operationId":"verifyEmail","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"3f5413dc-7018-41ff-8549-dec4cbc28068"}],"requestBody":{"description":"Request Body for Single Email Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerificationSingleRequest"},"examples":{"example":{"value":{"email":"example@mail.com"}}}}},"required":true},"responses":{"200":{"description":"Email Verified Successfully ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerificationSingleResponse"},"examples":{"example":{"value":{"response":{"status":"OK","email":{"address":"example@mail.com","result":"valid","freeEmail":"true","account":"example","domain":"mail.com","domainAgeDays":"9802","smtpProvider":"mail.com","mxFound":"true","mxRecord":"mx00.mail.com","processedAt":"2024-01-24T14:36:57.673Z"}}}}}}}},"400":{"description":"Invalid request for Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-EV-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid tokenfor Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests for Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"500":{"description":"Internal Server Error for Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Email Verification Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9408ae330240118eb4e83373413ef781","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/emails/verify/batch":{"post":{"tags":["Email Verification"],"summary":"Performs batch email verification","description":"This endpoint is for batch email verification upto maximum batch size 10.\n\n","operationId":"verifyBatchEmails","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"3f5413dc-7018-41ff-8549-dec4cbc28068"}],"requestBody":{"description":"Request Body for Batch Email Verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerificationBatchRequest"},"examples":{"example":{"value":{"emails":[{"id":"1","email":"example@mail.com"},{"id":"2","email":"john.smith@example.org"}]}}}}},"required":true},"responses":{"200":{"description":"Batch Emails Verified Successfully ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerificationBatchResponse"},"examples":{"example":{"value":{"responses":[{"id":"1","status":"OK","email":{"address":"example@mail.com","result":"valid","freeEmail":"true","account":"example","domain":"mail.com","domainAgeDays":"9802","smtpProvider":"mail.com","mxFound":"true","mxRecord":"mx00.mail.com","processedAt":"2024-01-24T14:36:57.673Z"}},{"id":"2","status":"OK","email":{"address":"john.smith@example.org","result":"do_not_mail","subResult":"global_suppression","freeEmail":"false","account":"john.smith","domain":"example.org","domainAgeDays":"10373","mxFound":"false","processedAt":"2024-01-24T14:39:02.203Z"}}]}}}}}},"206":{"description":"Batch Emails Verified partially","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerificationBatchResponse"},"examples":{"example":{"value":{"responses":[{"id":"1","status":"OK","email":{"address":"example@mail.com","result":"valid","freeEmail":"true","account":"example","domain":"mail.com","domainAgeDays":"9802","smtpProvider":"mail.com","mxFound":"true","mxRecord":"mx00.mail.com","processedAt":"2024-01-24T14:36:57.673Z"}},{"id":"2","code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"400":{"description":"Invalid request for Batch Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-EV-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for Batch Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for Batch Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"413":{"description":"Request entity too large for Batch Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"3f5413dc-7018-91ff-8549-dec4cbc28068","errors":[{"code":"DIS-EV-1001","detail":"Batch size must not exceed 10"}]}}}}}},"429":{"description":"Too many requests for Batch Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"500":{"description":"Internal Server Error for Batch Email API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Batch Email Verification Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9408ae330240118eb4e83373413ef781","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/geolocation/access-point":{"post":{"tags":["Geolocation"],"summary":"Returns com.precisely.geolocation for a Wifi access point","description":"The Geolocation Wifi Access end point provides the com.precisely.geolocation details.\n","operationId":"geoLocateWiFiAccessPoint","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"e8a838ca-14bf-4f0b-b29e-1ed2515b0772"}],"requestBody":{"description":"Wi-Fi access points data used for com.precisely.geolocation purposes. The request should contain information about the serving cell and other access points.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WiFiAccessPointRequest"},"examples":{"example":{"value":{"servingCell":{"mac":"00:22:75:10:d5:91","ssid":"","rssi":" -90","speed":"500"},"otherCells":[{"mac":"00:22:75:10:d5:91","ssid":"","rssi":" -90","speed":"100"}]}}}}},"required":true},"responses":{"200":{"description":"WiFi access point com.precisely.geolocation fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeolocationWiFiApiResponse"},"examples":{"example":{"value":{"response":{"status":"OK","result":{"geometry":{"type":"Point","coordinates":[-117.280957,33.13482],"accuracy":{"unit":"meters","value":"120"}}}}}}}}}},"400":{"description":"The request could not be processed due to invalid or missing parameters. Ensure that all required fields are provided in the correct format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"01b4729758992d304b39b9dba7a266bf","errors":[{"code":"DIS-GL-1005","detail":"Request payload servingCell can not be null or empty"}]}}}}}},"401":{"description":"Authentication failed or access token is missing. Ensure you provide a valid bearer token in the request header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"0049c2dbb58b8393e8bced346fd8d660","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"You do not have permission to access this resource. Ensure your API key or token has the correct permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"b17e82b13b6b7d88eaf886636fae8b4d","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Rate limit exceeded. Please wait before making more requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"f287c3b95d11f9ff28472ccc9ff38929","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"500":{"description":"An internal server error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"f287c3b95d11f9ff28472ccc9ff38929","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"The service is temporarily unavailable. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"29839eb5a3d5be926bcd789fb3d71585","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/geolocation/ip-address":{"get":{"tags":["Geolocation"],"summary":"Returns com.precisely.geolocation for an IP address","description":"The Geolocation Ip Address end point provides the com.precisely.geolocation details.\n","operationId":"geoLocateIpAddress","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"e8a838ca-14bf-4f0b-b29e-1ed2515b0772"},{"name":"ipAddress","in":"query","description":"The IP address for which the com.precisely.geolocation information is being requested.","required":true,"schema":{"type":"string"},"example":"0.0.0.0"}],"responses":{"200":{"description":"IP address com.precisely.geolocation fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeolocationIPApiResponse"},"examples":{"example":{"value":{"response":{"status":"OK","result":{"geometry":{"accuracy":{"unit":"meters","value":"232800"},"coordinates":[-77.49154,39.03328]},"ipInfo":{"coordinateFormat":"Decimal","ipAddress":"54.86.242.73","ipType":"Mapped","anonymizerStatus":"active","proxy":{"description":"hosting-cloud","lastDetected":"2024-05-06T06:46:27Z","level":"elite","name":"amazonaws.com","provider":"amazon technologies inc.","type":"service"},"network":{"organization":"amazon technologies inc.","organizationData":{"home":"false","organizationType":"unknown","naicsCode":"517810"},"carrier":"amazon.com","asn":14618,"connectionType":"tx","lineSpeed":"medium","ipRouteType":"international proxy","hostingFacility":"true","domainName":"amazonaws.com"},"location":{"city":{"areaCode":"703","name":"ashburn","confidence":60,"postalCode":"20147","postalCodeConfidence":35,"timeZone":-5.0},"consistencyCode":1,"continent":"north america","country":{"name":"united states","confidence":90,"code":"us","region":"mid-atlantic"},"dma":511,"msa":47900,"state":{"county":"loudoun","name":"virginia","confidence":75,"code":"va"}}}}}}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"6900b63d72d75452c6c982afef49dc70","errors":[{"code":"DIS-GL-1002","detail":"Invalid IP address found"}]}}}}}},"401":{"description":"Unauthorized: Invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"0049c2dbb58b8393e8bced346fd8d660","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"b17e82b13b6b7d88eaf886636fae8b4d","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"f287c3b95d11f9ff28472ccc9ff38929","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"f287c3b95d11f9ff28472ccc9ff38929","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"29839eb5a3d5be926bcd789fb3d71585","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/phone-numbers/validate":{"post":{"tags":["Phone Verification"],"summary":"Performs single phone number verification.","description":"This endpoint is for single phone number verification.","operationId":"validatePhone","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"3f5413dc-7018-41ff-8549-dec4cbc28068"}],"requestBody":{"description":"Request Body for Single Phone Number Validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidationSingleRequest"},"examples":{"example":{"value":{"phoneNumber":"7063062767","country":"US"}}}}},"required":true},"responses":{"200":{"description":"Phone verified successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidationSingleResponse"},"examples":{"example":{"value":{"response":{"status":"OK","phoneNumber":{"callingCountryCode":"1","country":"US","mobileCountryCode":"310","mobileNetworkCode":"010","carrierName":"Verizon Wireless","phoneType":"mobile","nationalNumberFormat":"(706) 306-2767","formattedPhoneNumber":"+17063062767","validStatus":true}}}}}}}},"400":{"description":"Invalid request for phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-PV-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests for phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"500":{"description":"Internal server error for phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Phone verification service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9408ae330240118eb4e83373413ef781","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/phone-numbers/validate/batch":{"post":{"tags":["Phone Verification"],"summary":"Performs batch phone number verification.","description":"This endpoint is for batch phone number verification with a maximum batch size of 10.","operationId":"validateBatchPhones","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"6e7774f8-300d-4f82-9d0d-7688027d08c2"}],"requestBody":{"description":"Request Body for Batch Phone Number Validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidationBatchRequest"},"examples":{"example":{"value":{"phoneNumbers":[{"id":"1","phoneNumber":"7063062767","country":"US"},{"id":"2","phoneNumber":"767425446","country":"SWE"}]}}}}},"required":true},"responses":{"200":{"description":"Batch phones verified successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidationBatchResponse"},"examples":{"example":{"value":{"responses":[{"status":"OK","id":"1","phoneNumber":{"callingCountryCode":"1","country":"US","mobileCountryCode":"310","mobileNetworkCode":"010","carrierName":"Verizon Wireless","phoneType":"mobile","nationalNumberFormat":"(706) 306-2767","formattedPhoneNumber":"+17063062767","validStatus":true}},{"status":"OK","id":"2","phoneNumber":{"callingCountryCode":"46","country":"SE","mobileCountryCode":"240","mobileNetworkCode":"01","carrierName":"TeliaSonera","phoneType":"mobile","nationalNumberFormat":"076-742 54 46","formattedPhoneNumber":"+46767425446","validStatus":true}}]}}}}}},"206":{"description":"Batch phones verified Partially","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidationBatchResponse"},"examples":{"example":{"value":{"responses":[{"status":"OK","id":"1","phoneNumber":{"country":"US","mobileCountryCode":"310","mobileNetworkCode":"010","carrierName":"Verizon Wireless","phoneType":"mobile","nationalNumberFormat":"(706) 306-2767","formattedPhoneNumber":"+17063062767","validStatus":true}},{"id":"2","code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"400":{"description":"Invalid request for batch Phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-PV-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for batch Phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for batch Phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"413":{"description":"Request entity too large for batch Phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"6e7774f8-300d-9f82-9d0d-7688027d08c2","errors":[{"code":"DIS-PV-1001","detail":"Batch size must not exceed 10"}]}}}}}},"429":{"description":"Too many requests for batch Phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"500":{"description":"Internal server error for batch Phone verification API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Batch phones verification service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9408ae330240118eb4e83373413ef781","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}}},"components":{"schemas":{"Accuracy":{"required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"The unit of measurement for the accuracy, typically in 'meters'.","example":"meters"},"value":{"type":"string","description":"The value of the accuracy, representing the radius within which the location is accurate.","example":"120"}},"description":"Represents the accuracy of the location data in terms of units and value."},"BbanStructureEntry":{"type":"object","properties":{"partType":{"type":"string","description":"The part type of this BBAN entry, e.g. bank_code, sort_code, account_number","example":"bank_code"},"length":{"type":"integer","description":"The length of this BBAN entry in characters","format":"int32","example":4},"characterType":{"type":"string","description":"The character type: n (numeric), a (alphabetic), c (alphanumeric)","example":"n"}},"description":"A single entry in the BBAN structure"},"CityResult":{"type":"object","properties":{"areaCode":{"type":"string","description":"The area code of the city","example":"703"},"name":{"type":"string","description":"The name of the city","example":"Ashburn"},"confidence":{"type":"integer","description":"Confidence score indicating the accuracy of the city information","format":"int32","example":60},"postalCode":{"type":"string","description":"Postal code for the city","example":"20147"},"postalCodeConfidence":{"type":"integer","description":"Confidence score indicating the accuracy of the postal code","format":"int32","example":35},"timeZone":{"type":"number","description":"Time zone offset from UTC in hours","format":"double","example":-5}},"description":"Detailed information about the city associated with the IP address"},"CountryResult":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the country","example":"United States"},"confidence":{"type":"integer","description":"Confidence score indicating the accuracy of the country information","format":"int32","example":90},"code":{"type":"string","description":"Two-letter country code according to ISO 3166-1 alpha-2","example":"US"},"region":{"type":"string","description":"Region within the country","example":"Mid-Atlantic"}},"description":"Details about the country associated with the IP address"},"EmailBatchResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"id":{"type":"string","description":"id of the response","example":"7c5f3569-fc19-49aa-bffd-0ba755e84f28"},"code":{"type":"string","description":"Error code from the service","example":"DIS-1003"},"detail":{"type":"string","description":"Error details from the service","example":"Issue with internal services. Please try again after sometime"},"email":{"description":"Validated Response","allOf":[{"$ref":"#/components/schemas/EmailVerification"}]}},"description":"response of email verification"},"EmailSingleResponse":{"required":["status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"email":{"description":"Single Email Validated Response","allOf":[{"$ref":"#/components/schemas/EmailVerification"}]}},"description":"Single email verification response"},"EmailVerification":{"type":"object","properties":{"address":{"type":"string","description":"The email address to be validated","example":"example@mail.com"},"result":{"type":"string","description":"The status of the validated email","example":"valid"},"subResult":{"type":"string","description":"The sub status of the validated email","example":"valid"},"freeEmail":{"type":"string","description":"[true/false] If the email comes from a free provider","example":"true"},"didYouMean":{"type":"string","description":"Suggestive Fix for an email typo","example":"example@gmail.com"},"account":{"type":"string","description":"The portion of the email address before the \"@\" symbol","example":"example"},"domain":{"type":"string","description":"The portion of the email address after the \"@\" symbol","example":"mail.com"},"domainAgeDays":{"type":"string","description":"Age of the email domain in days","example":"9802"},"smtpProvider":{"type":"string","description":"The SMTP Provider of the email","example":"mail.com"},"mxFound":{"type":"string","description":"[true/false] Does the domain have an MX record","example":"true"},"mxRecord":{"type":"string","description":"The preferred MX record of the domain","example":"mx00.mail.com"},"firstName":{"type":"string","description":"The first name of the owner of the email when available","example":"John"},"lastName":{"type":"string","description":"The last name of the owner of the email when available","example":"doe"},"gender":{"type":"string","description":"The gender of the owner of the email when available","example":"male"},"processedAt":{"type":"string","description":"The time the email was validated in ISO 8601 format","example":"2024-01-24T14:36:57.673Z"},"error":{"type":"string","description":"message from the underlying service","example":"invalid syntax"}},"description":"Email Verification Response"},"EmailVerificationBatchRequest":{"required":["emails"],"type":"object","properties":{"emails":{"minItems":1,"type":"array","description":"List of email to be verified","items":{"$ref":"#/components/schemas/EmailWithId"}}},"description":"The email address to be validated along with optional parameter id"},"EmailVerificationBatchResponse":{"type":"object","properties":{"responses":{"type":"array","description":"List of emails validated","items":{"$ref":"#/components/schemas/EmailBatchResponse"}}},"description":"response of batch email verification"},"EmailVerificationSingleRequest":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"Email which needs to be validated","example":"example@mail.com","x-not-null-message":"EmailVerification: Email can not be blank"}},"description":"Request Body for single email verification"},"EmailVerificationSingleResponse":{"type":"object","properties":{"response":{"description":"Response structure of validated email","allOf":[{"$ref":"#/components/schemas/EmailSingleResponse"}]}},"description":"response of single email verification"},"EmailWithId":{"required":["email"],"type":"object","properties":{"id":{"type":"string","description":"Id for the response","nullable":true,"example":"1234"},"email":{"type":"string","description":"The email address that needs to be validated","example":"example@mail.com"}},"description":"The email address which needs to be validated along with optional parameter id"},"ErrorDetail":{"required":["detail"],"type":"object","properties":{"code":{"type":"string","description":"A unique code representing the specific error.","example":"DIS-1001"},"detail":{"type":"string","description":"A detailed message describing the error.","example":"Unauthorized"}},"description":"Error details."},"ErrorResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the error.","example":"ad45c1aded938181a05f256e5a1b594d"},"errors":{"type":"array","description":"List of errors ","items":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"Error response."},"GeolocationIPApiResponse":{"type":"object","properties":{"response":{"description":"The response details for IP-based com.precisely.geolocation","allOf":[{"$ref":"#/components/schemas/GeolocationIPResponse"}]}},"description":"Response object containing the status and result of the IP-based com.precisely.geolocation"},"GeolocationIPResponse":{"required":["status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"description":"The result of the IP com.precisely.geolocation request","allOf":[{"$ref":"#/components/schemas/IpLocationResponseResult"}]}},"description":"The response object containing the status and the IP-based com.precisely.geolocation result"},"GeolocationWiFiApiResponse":{"type":"object","properties":{"response":{"description":"The com.precisely.geolocation response containing status and result data.","allOf":[{"$ref":"#/components/schemas/GeolocationWiFiResponse"}]}},"description":"Response for the HTTP Geolocation WiFi API."},"GeolocationWiFiResponse":{"required":["status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"description":"The result of the WiFi com.precisely.geolocation query, including coordinates and accuracy.","allOf":[{"$ref":"#/components/schemas/WiFiAccessPointResult"}]}},"description":"Response containing the status and result of the WiFi-based com.precisely.geolocation request."},"Geometry":{"type":"object","properties":{"accuracy":{"description":"The accuracy of the location measurement","allOf":[{"$ref":"#/components/schemas/Accuracy"}]},"coordinates":{"type":"array","description":"List of latitude and longitude coordinates","example":[-77.49154,39.03328],"items":{"type":"number","format":"double"}}},"description":"Geometric information containing accuracy and coordinates data"},"IbanStructureResult":{"type":"object","properties":{"countryIso2":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"GB"},"ibanLength":{"type":"integer","description":"Total length of IBAN for this country","format":"int32","example":22},"bbanStructure":{"type":"array","description":"Ordered list of BBAN structure entries","items":{"$ref":"#/components/schemas/BbanStructureEntry"}}},"description":"IBAN and BBAN structure details for a country"},"IpInfoResult":{"type":"object","properties":{"coordinateFormat":{"type":"string","description":"Format of the geographic coordinates (e.g., Decimal, DMS)","example":"Decimal"},"ipAddress":{"type":"string","description":"The IP address being analyzed","example":"54.86.242.73"},"ipType":{"type":"string","description":"The type of IP address (e.g., Public, Mapped)","example":"Mapped"},"anonymizerStatus":{"type":"string","description":"Anonymizer status for the IP address (e.g., active, inactive)","example":"active"},"proxy":{"description":"Information about the proxy, if applicable","allOf":[{"$ref":"#/components/schemas/ProxyResult"}]},"network":{"description":"Network-related information, including organization and connection details","allOf":[{"$ref":"#/components/schemas/Network"}]},"location":{"description":"Location data, including city, state, country, and other related details","allOf":[{"$ref":"#/components/schemas/LocationResult"}]}},"description":"IP Information containing details about the IP address, proxy, network, and location."},"IpLocationResponseResult":{"type":"object","properties":{"geometry":{"description":"Geometric information including coordinates and accuracy","allOf":[{"$ref":"#/components/schemas/Geometry"}]},"ipInfo":{"description":"IP Information related to network, proxy, and location details","allOf":[{"$ref":"#/components/schemas/IpInfoResult"}]}},"description":"The result object containing IP-based com.precisely.geolocation details and IP information"},"LocationResult":{"type":"object","properties":{"city":{"description":"Details about the city","allOf":[{"$ref":"#/components/schemas/CityResult"}]},"consistencyCode":{"type":"integer","description":"Code indicating consistency of the location data","format":"int32","example":1},"continent":{"type":"string","description":"The continent where the IP address is located","example":"North America"},"country":{"description":"Details about the country","allOf":[{"$ref":"#/components/schemas/CountryResult"}]},"dma":{"type":"integer","description":"Designated Market Area (DMA) code","format":"int32","example":511},"msa":{"type":"integer","description":"Metropolitan Statistical Area (MSA) code","format":"int32","example":47900},"state":{"description":"Details about the state","allOf":[{"$ref":"#/components/schemas/StateResult"}]}},"description":"Location information for the com.precisely.geolocation IP response"},"Network":{"type":"object","properties":{"organization":{"type":"string","description":"The name of the organization owning or managing the IP address","example":"Amazon Technologies Inc."},"organizationData":{"description":"Additional data about the organization","allOf":[{"$ref":"#/components/schemas/OrganizationData"}]},"carrier":{"type":"string","description":"The carrier or service provider associated with the IP address","example":"Amazon.com"},"asn":{"type":"integer","description":"Autonomous System Number (ASN) associated with the IP address","format":"int32","example":14618},"connectionType":{"type":"string","description":"Type of network connection (e.g., broadband, mobile)","example":"TX"},"lineSpeed":{"type":"string","description":"Line speed classification (e.g., high, medium, low)","example":"medium"},"ipRouteType":{"type":"string","description":"Type of IP routing (e.g., domestic, international proxy)","example":"international proxy"},"hostingFacility":{"type":"string","description":"Indicates if the IP address is associated with a hosting facility","example":"true"},"domainName":{"type":"string","description":"The domain name associated with the IP address","example":"amazonaws.com"}},"description":"Details about the network associated with the IP address"},"OrganizationData":{"type":"object","properties":{"home":{"type":"string","description":"Indicates whether the organization is a home-based entity","example":"false"},"organizationType":{"type":"string","description":"Type of organization, such as 'commercial', 'non-profit', or 'unknown'","example":"commercial"},"naicsCode":{"type":"string","description":"North American Industry Classification System (NAICS) code representing the industry of the organization","example":"517810"},"isicCode":{"type":"string","description":"International Standard Industrial Classification (ISIC) code representing the industry of the organization","example":"6110"}},"description":"Additional data about the organization associated with the IP address"},"OtherCellRequest":{"required":["mac"],"type":"object","properties":{"mac":{"type":"string","description":"Unique MAC address identifying the WiFi access point.","example":"00:22:75:10:d5:91"},"ssid":{"type":"string","description":"SSID (Service Set Identifier) of the WiFi network, representing the network name.","nullable":true,"example":"Office_WiFi"},"rssi":{"type":"string","description":"RSSI (Received Signal Strength Indicator) in dBm, showing the signal strength of the access point.","nullable":true,"example":"-75"},"speed":{"type":"string","description":"Speed of the WiFi network in Mbps.","nullable":true,"example":"100"}},"description":"Represents a nearby WiFi access point, providing details such as MAC address, SSID, signal strength, and network speed."},"PhoneBatchResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"id":{"type":"string","description":"Alphanumeric ID associated with the phone verification request.","example":"1"},"phoneNumber":{"description":"Details of the verified phone, including carrier, type, and verified information.","allOf":[{"$ref":"#/components/schemas/PhoneValidation"}]},"code":{"type":"string","description":"Error code returned by the service, if applicable.","example":"DIS-1003"},"detail":{"type":"string","description":"Detailed error message provided by the service, if applicable.","example":"Issue with internal services. Please try again after sometime"}},"description":"Represents the response for a batch phone verification request. Each item includes the verified status, phone details, and any associated errors."},"PhoneSingleResponse":{"required":["status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"phoneNumber":{"description":"Details of the verified phone number, including carrier, type, and verified information.","allOf":[{"$ref":"#/components/schemas/PhoneValidation"}]}},"description":"Represents the response for a single phone verification request, including the status and verification details of the phone number."},"PhoneValidation":{"type":"object","properties":{"callingCountryCode":{"type":"string","description":"The country calling code associated with the phone number.","example":"1"},"country":{"type":"string","description":"The country associated with the phone number in ISO2 or ISO3 format.","example":"CAN"},"mobileCountryCode":{"type":"string","description":"The mobile country code (MCC) of the phone number.","example":"310"},"mobileNetworkCode":{"type":"string","description":"The mobile network code (MNC) of the phone number.","example":"010"},"carrierName":{"type":"string","description":"The name of the carrier associated with the phone number.","example":"Verizon Wireless"},"phoneType":{"type":"string","description":"The type of phone number, such as 'mobile' or 'landline'.","example":"mobile"},"nationalNumberFormat":{"type":"string","description":"The phone number in national format.","example":"(706) 306-2767"},"formattedPhoneNumber":{"type":"string","description":"The phone number in international format.","example":"17063062767"},"validStatus":{"type":"boolean","description":"Indicates whether the phone number is valid.","example":true},"validationDescription":{"type":"string","description":"A detailed description of the validation result.","example":"Phone number validation successful."},"qualityScore":{"type":"string","description":"A quality score for the phone number verification.","example":"0.95"}},"description":"Represents the response for phone verification."},"PhoneValidationBatchRequest":{"required":["phoneNumbers"],"type":"object","properties":{"phoneNumbers":{"minItems":1,"type":"array","description":"A list of phone numbers to be verified, each optionally associated with an ID.","items":{"$ref":"#/components/schemas/PhoneValidationRequestWithId"}}},"description":"Represents the request for batch phone number verifications."},"PhoneValidationBatchResponse":{"type":"object","properties":{"responses":{"type":"array","description":"List of responses for the batch phone verification request.","items":{"$ref":"#/components/schemas/PhoneBatchResponse"}}},"description":"Represents the response for a batch phone verification request."},"PhoneValidationRequestWithId":{"required":["phoneNumber"],"type":"object","properties":{"id":{"type":"string","description":"Optional identifier for the request.","nullable":true,"example":"2"},"phoneNumber":{"type":"string","description":"The phone number to be verified.","example":"9712345731"},"country":{"type":"string","description":"Optional input for the country code in ISO2 or ISO3 format.","example":"CAN"}},"description":"Represents a phone verification request, including the phone number to be verified along with an optional 'id'."},"PhoneValidationSingleRequest":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"Phone number to be verified. Include the country code if applicable.","example":"+1234567890","x-size-message":"PhoneValidation: Phone number cannot be blank."},"country":{"type":"string","description":"Optional country code in ISO2 or ISO3 format to assist in phone number verification.","example":"US"}},"description":"Request for single phone verification, including optional country code for verification assistance."},"PhoneValidationSingleResponse":{"type":"object","properties":{"response":{"description":"Details of the verified phone number.","allOf":[{"$ref":"#/components/schemas/PhoneSingleResponse"}]}},"description":"Represents the response for a single phone verification request."},"ProxyResult":{"type":"object","properties":{"description":{"type":"string","description":"Description of the proxy server's function or nature (e.g., hosting-cloud, anonymizer)","example":"hosting-cloud"},"lastDetected":{"type":"string","description":"The last detected date and time the proxy was observed in action (ISO 8601 format)","example":"2024-05-06T06:46:27Z"},"level":{"type":"string","description":"The level of the proxy server (e.g., elite, transparent)","example":"elite"},"name":{"type":"string","description":"The name of the proxy server or service provider","example":"amazonaws.com"},"provider":{"type":"string","description":"The organization or company providing the proxy service","example":"Amazon Technologies Inc."},"type":{"type":"string","description":"The type of proxy service (e.g., service, residential, corporate)","example":"service"}},"description":"Details of the proxy server associated with the IP address"},"ServingCellRequest":{"required":["mac"],"type":"object","properties":{"mac":{"type":"string","description":"MAC address of the WiFi access point.","example":"00:22:75:10:d5:91"},"ssid":{"type":"string","description":"SSID (Service Set Identifier) of the WiFi network.","nullable":true,"example":"Home_WiFi"},"rssi":{"type":"string","description":"RSSI (Received Signal Strength Indicator) value in dBm, representing signal strength.","nullable":true,"example":"-90"},"speed":{"type":"string","description":"The speed of the WiFi network in Mbps.","nullable":true,"example":"500"}},"description":"Represents the serving cell in a WiFi network, including details such as MAC address, SSID, RSSI, and speed."},"StateResult":{"type":"object","properties":{"county":{"type":"string","description":"The county within the state or region","example":"Loudoun"},"name":{"type":"string","description":"The full name of the state or region","example":"Virginia"},"confidence":{"type":"integer","description":"Confidence score indicating the accuracy of the state or region information","format":"int32","example":75},"code":{"type":"string","description":"The two-letter state code, if applicable","example":"VA"}},"description":"Details about the state or region within a country associated with the IP address"},"Status":{"type":"string","description":"Represents the status of a response","example":"OK","enum":["OK","ZERO_RESULTS"]},"StructureApiResponse":{"type":"object","properties":{"response":{"description":"The response details for IBAN structure lookup","allOf":[{"$ref":"#/components/schemas/StructureResponse"}]}},"description":"Top-level API response wrapper for IBAN structure"},"StructureResponse":{"required":["status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"description":"The IBAN structure result","allOf":[{"$ref":"#/components/schemas/IbanStructureResult"}]}},"description":"The response object containing the status and IBAN structure result"},"WiFiAccessPointRequest":{"required":["servingCell"],"type":"object","properties":{"servingCell":{"description":"Information about the primary serving WiFi access point.","allOf":[{"$ref":"#/components/schemas/ServingCellRequest"}]},"otherCells":{"type":"array","description":"Optional list of other detected WiFi access points.","nullable":true,"items":{"$ref":"#/components/schemas/OtherCellRequest"}}},"description":"Represents a request containing WiFi access point information, including serving and other cells."},"WiFiAccessPointResult":{"required":["geometry"],"type":"object","properties":{"geometry":{"description":"The geometry result of the com.precisely.geolocation query, containing coordinates and accuracy data.","allOf":[{"$ref":"#/components/schemas/WiFiGeometryResult"}]}},"description":"Represents the result of a WiFi com.precisely.geolocation request, including the geometry of the location."},"WiFiGeometryResult":{"required":["accuracy","coordinates","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the geometry object, typically 'Point'.","example":"Point"},"coordinates":{"type":"array","description":"A list of coordinates representing the location. The first value is longitude, and the second is latitude.","example":[-77.49154,39.03328],"items":{"type":"number","format":"double"}},"accuracy":{"description":"The accuracy of the location in terms of distance, typically measured in meters.","allOf":[{"$ref":"#/components/schemas/Accuracy"}]}},"description":"Represents the geometric details of the com.precisely.geolocation result, including type, coordinates, and accuracy."}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Pass the value in the following format: Apikey <base64(api_key:api_secret)>.","name":"Authorization","in":"header"},"bearerAuth":{"type":"http","description":"Pass the value as JWT Bearer Token.","scheme":"bearer"}}}}