openapi: 3.0.1 info: contact: name: Precisely APIs Support url: https://support.precisely.com description: ' Demographics. Audience Enrichment. Add local demographics and lifestyle segmentation to your audience profiles. The Demographics API returns household demographics and lifestyle characteristics with the input of an address, location coordinate, or geographic boundary. This service covers select countries.' license: name: Apache 2.0 url: http://springdoc.org termsOfService: http://swagger.io/terms/ title: Precisely APIs Key API version: 18.1.0 servers: - url: https://api.precisely.com security: - oAuth2Password: - '' tags: - name: Key paths: /geocode/v1/key/byaddress: get: description: This service accepts an address and returns the corresponding PreciselyID operationId: getPBKey parameters: - description: The address to be searched. in: query name: address required: true schema: type: string - description: 3 letter ISO code of the country to be searched. in: query name: country required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PBKeyResponse' application/xml: schema: $ref: '#/components/schemas/PBKeyResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/ErrorInfo' application/xml: schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request '500': content: application/json: schema: type: string application/xml: schema: type: string description: Internal Server Error security: - oAuth2Password: [] summary: Get PreciselyID By Address tags: - Key x-accepts: application/json post: description: This is a Batch offering for 'PreciselyID By Address' service. It accepts a single address or a list of addresses and returns the corresponding PreciselyID. operationId: getPBKeys requestBody: content: application/json: schema: $ref: '#/components/schemas/PBKeyAddressRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PBKeyResponseList' application/xml: schema: $ref: '#/components/schemas/PBKeyResponseList' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/ErrorInfo' application/xml: schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request '500': content: application/json: schema: type: string application/xml: schema: type: string description: Internal Server Error security: - oAuth2Password: [] summary: Post PreciselyID By Address tags: - Key x-contentType: application/json x-accepts: application/json components: schemas: PBKeyResponse: example: key: key matchedAddress: country: country streetSide: streetSide city: city displayName: displayName postalCode: postalCode latitude: latitude businessName: businessName county: county unitType: unitType streetName: streetName formattedAddress: formattedAddress addressLine1: addressLine1 mainAddressLine: mainAddressLine addressLine2: addressLine2 addressLine3: addressLine3 objectId: objectId addressLastLine: addressLastLine longitude: longitude unitValue: unitValue stateProvince: stateProvince urbanizationName: urbanizationName areaName1: areaName1 areaName2: areaName2 areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber postCode: postCode postCodeExt: postCodeExt placeName: placeName status: status properties: key: type: string matchedAddress: $ref: '#/components/schemas/address' type: object xml: name: pbKeyResponse PBKeyAddressRequest: example: addresses: - country: country customFields: key: '{}' postCode2: postCode2 unitType: unitType areaName1: areaName1 postCode1: postCode1 areaName2: areaName2 streetName: streetName areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber mainAddressLine: mainAddressLine placeName: placeName objectId: objectId addressLastLine: addressLastLine unitValue: unitValue - country: country customFields: key: '{}' postCode2: postCode2 unitType: unitType areaName1: areaName1 postCode1: postCode1 areaName2: areaName2 streetName: streetName areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber mainAddressLine: mainAddressLine placeName: placeName objectId: objectId addressLastLine: addressLastLine unitValue: unitValue properties: addresses: items: $ref: '#/components/schemas/GeocodeAddress' type: array xml: name: address required: - addresses type: object xml: name: keyByAddressRequest GeocodeAddress: example: country: country customFields: key: '{}' postCode2: postCode2 unitType: unitType areaName1: areaName1 postCode1: postCode1 areaName2: areaName2 streetName: streetName areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber mainAddressLine: mainAddressLine placeName: placeName objectId: objectId addressLastLine: addressLastLine unitValue: unitValue properties: objectId: type: string mainAddressLine: type: string addressLastLine: type: string placeName: type: string areaName1: type: string areaName2: type: string areaName3: type: string areaName4: type: string postCode1: type: string postCode2: type: string country: type: string addressNumber: type: string streetName: type: string unitType: type: string unitValue: type: string customFields: additionalProperties: type: object type: object type: object address: example: country: country streetSide: streetSide city: city displayName: displayName postalCode: postalCode latitude: latitude businessName: businessName county: county unitType: unitType streetName: streetName formattedAddress: formattedAddress addressLine1: addressLine1 mainAddressLine: mainAddressLine addressLine2: addressLine2 addressLine3: addressLine3 objectId: objectId addressLastLine: addressLastLine longitude: longitude unitValue: unitValue stateProvince: stateProvince urbanizationName: urbanizationName areaName1: areaName1 areaName2: areaName2 areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber postCode: postCode postCodeExt: postCodeExt placeName: placeName status: status properties: objectId: type: string displayName: type: string streetSide: type: string businessName: type: string addressLine1: type: string addressLine2: type: string addressLine3: type: string city: type: string stateProvince: type: string county: type: string postalCode: type: string latitude: type: string longitude: type: string status: type: string urbanizationName: type: string formattedAddress: type: string mainAddressLine: type: string addressLastLine: type: string placeName: type: string areaName1: type: string areaName2: type: string areaName3: type: string areaName4: type: string postCode: type: string postCodeExt: type: string country: type: string addressNumber: type: string streetName: type: string unitType: type: string unitValue: type: string type: object xml: name: address pbkey: example: objectId: objectId key: key matchedAddress: country: country streetSide: streetSide city: city displayName: displayName postalCode: postalCode latitude: latitude businessName: businessName county: county unitType: unitType streetName: streetName formattedAddress: formattedAddress addressLine1: addressLine1 mainAddressLine: mainAddressLine addressLine2: addressLine2 addressLine3: addressLine3 objectId: objectId addressLastLine: addressLastLine longitude: longitude unitValue: unitValue stateProvince: stateProvince urbanizationName: urbanizationName areaName1: areaName1 areaName2: areaName2 areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber postCode: postCode postCodeExt: postCodeExt placeName: placeName status: status properties: objectId: type: string key: type: string matchedAddress: $ref: '#/components/schemas/address' type: object xml: name: pbkey PBKeyResponseList: example: pbkey: - objectId: objectId key: key matchedAddress: country: country streetSide: streetSide city: city displayName: displayName postalCode: postalCode latitude: latitude businessName: businessName county: county unitType: unitType streetName: streetName formattedAddress: formattedAddress addressLine1: addressLine1 mainAddressLine: mainAddressLine addressLine2: addressLine2 addressLine3: addressLine3 objectId: objectId addressLastLine: addressLastLine longitude: longitude unitValue: unitValue stateProvince: stateProvince urbanizationName: urbanizationName areaName1: areaName1 areaName2: areaName2 areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber postCode: postCode postCodeExt: postCodeExt placeName: placeName status: status - objectId: objectId key: key matchedAddress: country: country streetSide: streetSide city: city displayName: displayName postalCode: postalCode latitude: latitude businessName: businessName county: county unitType: unitType streetName: streetName formattedAddress: formattedAddress addressLine1: addressLine1 mainAddressLine: mainAddressLine addressLine2: addressLine2 addressLine3: addressLine3 objectId: objectId addressLastLine: addressLastLine longitude: longitude unitValue: unitValue stateProvince: stateProvince urbanizationName: urbanizationName areaName1: areaName1 areaName2: areaName2 areaName3: areaName3 areaName4: areaName4 addressNumber: addressNumber postCode: postCode postCodeExt: postCodeExt placeName: placeName status: status properties: pbkey: items: $ref: '#/components/schemas/pbkey' type: array type: object xml: name: pbKeyResponse ErrorInfo: properties: errors: items: $ref: '#/components/schemas/ErrorCode' type: array xml: name: error type: object xml: name: errors ErrorCode: properties: errorCode: type: string errorDescription: type: string type: object securitySchemes: oAuth2Password: flows: implicit: authorizationUrl: https://api.precisely.com/oauth/token scopes: bearer token: put your bearer token here. type: oauth2 externalDocs: description: Online Documentation url: https://docs.precisely.com/docs/sftw/precisely-apis/main/en-us/webhelp/apis/index.html