Data8-databerikning
Data8 hjälper dig att skapa förtroende för dina data. Vi kan spara pengar genom att rensa och berika både dina befintliga data och se till att endast data av högsta kvalitet går in vid startpunkten, vilket gör att du kan koncentrera dig på att rikta in dig på och kommunicera med rätt kunder.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Teknisk support |
| URL | https://www.data-8.co.uk |
| E-postmeddelande | helpdesk@data-8.co.uk |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Data8 Begränsad |
| Webbplats | https://www.data-8.co.uk |
| Integritetspolicy | https://www.data-8.co.uk/privacy-policy/ |
| Kategorier | Artificiell intelligens; Webbplats |
Data8 Data Enrichment erbjuder ett antal åtgärder som möjliggör kontroll av datakvalitet – se till att alla data som anges i ett system är verkliga, giltiga, uppdaterade och funktioner efter behov. I en värld av AI & Copilot är data kärnan och Data8 hjälper dig att maximera användningen av din mest uppskattade tillgång.
Förutsättningar
- Ett Data8-konto med krediter för varje åtgärd
- En API-nyckel som genereras från Data8-kontot
Hämta autentiseringsuppgifter
När du har ett Data8-konto kan du hämta en API-nyckel från Data8-instrumentpanelen.
Kom igång med anslutningsappen
Alla Data8-åtgärder kommer direkt från Data8-API:et – se den tillämpliga dokumentationssidan för varje slutpunkt och hur den fungerar – https://www.data-8.co.uk/resources/api-reference/
Vanliga fel och åtgärder
Data8-supportteamet är alltid tillgängliga för att hjälpa till vid eventuella problem – helpdesk@data-8.co.uk
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Shareable |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är en delningsbar anslutning. Om power-appen delas med en annan användare delas även anslutningen. Mer information finns i Översikt över anslutningsappar för arbetsyteappar – Power Apps | Microsoft Docs
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| API-nyckel | securestring | API-nyckeln för det här API:et | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| CTPS-kontroll |
Kontrollerar om ett telefonnummer är registrerat på CTPS eller inte. |
| Hämta fullständig adress |
Söker efter en adress baserat på indata, till exempel byggnadsnummer och postnummer |
| Kontrollera användbart namn |
Kontrollera, verifiera och verifiera om ett angivet namn sannolikt är ett verkligt och användbart namn eller om det är oanvändbart, salacious, slumpmässigt eller tomt. |
|
Predictive |
DrillDown med API:et Data8 PredictiveAddress – Öka detaljnivån ytterligare i sökresultat |
|
Predictive |
Hämta med API:et Data8 PredictiveAddress – Hämta den fullständiga adressen |
|
Predictive |
Söka med API:et Data8 PredictiveAddress – Sök efter en partiell adress i våra många datakällor |
| Rensa adress |
Formaterar, verifierar och korrigerar en viss adress till en fullständig formaterad adress. |
| Rensa e-post |
Rensa en e-postadress, verifiera den för att se om det är ett riktigt, äkta e-postmeddelande men ta också ytterligare information som ett namn eller företagsnamn för att berika ytterligare |
| TPS-kontroll |
Kontrollerar om ett telefonnummer är registrerat på TPS eller inte. |
| Verifiera bankkontoinformation |
Kontrollera om en sorteringskod och bankkontonummer är giltiga. |
| Verifiera e-postadress |
Kontrollera, verifiera och kontrollera om en e-postadress är giltig, verklig och skulle få e-post om den skickades en. Detta fungerar som en e-postverifieringstjänst i realtid. |
| Verifiera telefonnummer |
Kontrollerar om ett telefonnummer är giltigt för att ta emot ett telefonsamtal. Den kontrollerar telefonlinjens aktuella status i realtid och returnerar ett svar. |
| Verifiera telefonnummer (inaktuellt) |
Kontrollerar om en inmatad e-postadress är giltig för att ta emot e-post – detta är inaktuellt till förmån för PhoneValidation |
| Är avliden |
Storbritannien – Identifiera avlidna individer snabbt och enkelt med hjälp av trovärdiga källor som uppdateras regelbundet. |
CTPS-kontroll
Kontrollerar om ett telefonnummer är registrerat på CTPS eller inte.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Telefonnummer
|
number | True | string |
Det telefonnummer som du vill kontrollera |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Är anropsbar
|
Callable | boolean |
Returnerar ett booleskt värde som låter dig veta om det kan anropas. Om värdet är falskt finns det för närvarande på CTPS. |
|
Telefonnummer
|
TelephoneNumber | string |
Om det är ifyllt är telefonnumret anropsbart och null om det inte är |
Hämta fullständig adress
Söker efter en adress baserat på indata, till exempel byggnadsnummer och postnummer
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Licens
|
licence | True | string |
Eftersom Royal Mail PAF-databasen kan licensieras på flera sätt anger den här parametern under vilken licens du har åtkomst till data. Detta måste matcha den variant som du har en licens eller krediter för – om du är osäker på vilket alternativ du ska välja kontaktar du din kontoansvarige |
|
Postnummer
|
postcode | True | string |
Det fullständiga postnumret som du vill hämta adresser för. Formatering av postnumret spelar ingen roll så "ch24ne", "CH2 4NE", "ch02 4Ne" accepteras alla. |
|
Byggnad
|
building | string |
Ett valfritt värde för att filtrera de returnerade adresserna efter byggnadsnamn, nummer, underlokal (t.ex. platt nummer) eller företagsnamn. Om null eller "" anges inkluderas alla adresser i postnumret i resultatet. |
|
|
FixTownCounty
|
FixTownCounty | boolean |
sant för att säkerställa att staden och länet returneras i de två sista adressraderna, eller falskt om de ska visas på den första tillgängliga raden. |
|
|
MaxLines
|
MaxLines | integer |
Antalet rader som adressen ska formateras över. Ytterligare en rad inkluderas i resultatet för postnumret. |
|
|
MaxLineLength
|
MaxLineLength | integer |
Det maximala antalet tecken som kan visas på varje adressrad. |
|
|
NormalizeCase
|
NormalizeCase | boolean |
Konverterar all text i adressen utom stadens namn till rätt skiftläge. |
|
|
NormalizeTownCase
|
NormalizeTownCase | boolean |
Konverterar ortnamnet till rätt ärende |
|
|
ExcludeCounty
|
ExcludeCounty | boolean |
Exkluderar länet, om det finns någon, från den formaterade adressen |
|
|
UseAnyAvailableCounty
|
UseAnyAvailableCounty | boolean |
Använder alla tillgängliga län för att fylla i den formaterade adressen, inte bara postlänet |
|
|
Oönskadpunctuation
|
UnwantedPunctuation | boolean |
En sträng som innehåller eventuella skiljetecken som ska tas bort från den formaterade adressen |
|
|
FixBuilding
|
FixBuilding | boolean |
Ser till att byggnadens namn/nummer alltid placeras på den första raden |
|
|
IncludeUDPRN
|
IncludeUDPRN | boolean |
Ange till true om du vill att fältet UniqueReference för varje returnerad adress ska fyllas i med UDPRN |
|
|
IncludeLocation
|
IncludeLocation | boolean |
Ange till true om du vill att fältet Plats för varje returnerad adress ska fyllas i med geokodningsinformationen för adressen |
|
|
ReturnResultCount
|
ReturnResultCount | boolean |
Anger om fältet ResultCount i resultatet ska fyllas i med det totala antalet adresser som returneras. |
|
|
InkluderaNYB
|
IncludeNYB | boolean |
Ställ in på true för att inkludera adresser från databasen Som ännu inte har skapats i resultaten (kräver ytterligare licensiering) |
|
|
IncludeMR
|
IncludeMR | boolean |
Ställ in på true för att inkludera adresser från databasen Multiple Residency i resultaten (kräver ytterligare licensiering) |
|
|
Formatter
|
Formatter | string |
Välj från en av de tillgängliga formateringarna för att styra hur råadressen konverteras till en läsbar adress för människor |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Success |
|
Felmeddelande
|
Status.ErrorMessage | string |
Felmeddelande (om tillämpligt) |
|
CreditsRemaining
|
Status.CreditsRemaining | float |
Återstående krediter |
|
Innehåller antalet adresser i fältet Resultat. Det här fältet fylls bara i om alternativet ReturnResultCount är inställt på true
|
ResultCount | integer | |
|
Results
|
Results | array of object |
Results |
|
Linjer
|
Results.Address.Lines | array of string |
Formaterade adressrader |
|
Organisation
|
Results.RawAddress.Organisation | string |
Organisation |
|
Avdelning
|
Results.RawAddress.Department | string |
Avdelning |
|
AddressKey
|
Results.RawAddress.AddressKey | integer |
Adressnyckel |
|
OrganisationKey
|
Results.RawAddress.OrganisationKey | integer |
Organisationsnyckel |
|
PostcodeType
|
Results.RawAddress.PostcodeType | string |
Postnummertyp |
|
BuildingNumber
|
Results.RawAddress.BuildingNumber | integer |
Byggnadsnummer |
|
SubBuildingName
|
Results.RawAddress.SubBuildingName | string |
Namn på underbyggnad |
|
BuildingName
|
Results.RawAddress.BuildingName | string |
Byggnadsnamn |
|
DependentThoroughfareName
|
Results.RawAddress.DependentThoroughfareName | string |
Namn på beroende genomfartsleder |
|
DependentThoroughfareDesc
|
Results.RawAddress.DependentThoroughfareDesc | string |
Beroende genomfartsleder Desc |
|
ThoroughfareName
|
Results.RawAddress.ThoroughfareName | string |
Namn på genomfartsleder |
|
ThoroughfareDesc
|
Results.RawAddress.ThoroughfareDesc | string |
Genomfartsleder Desc |
|
DoubleDependentLocality
|
Results.RawAddress.DoubleDependentLocality | string |
Dubbel beroende ort |
|
DependentLocality
|
Results.RawAddress.DependentLocality | string |
Beroende ort |
|
Lokalitet
|
Results.RawAddress.Locality | string |
Lokalitet |
|
Postnummer
|
Results.RawAddress.Postcode | string |
Postnummer |
|
Dps
|
Results.RawAddress.Dps | string |
DPS |
|
Pobox
|
Results.RawAddress.PoBox | string |
PO Box |
|
PostalCounty
|
Results.RawAddress.PostalCounty | string |
Postlän |
|
TraditionalCounty
|
Results.RawAddress.TraditionalCounty | string |
Traditionellt län |
|
AdministrativeCounty
|
Results.RawAddress.AdministrativeCounty | string |
Administrativt län |
|
CountryISO2
|
Results.RawAddress.CountryISO2 | string |
Land ISO2 |
|
UniqueReference
|
Results.RawAddress.UniqueReference | string |
Unik referens |
|
Östlig
|
Results.RawAddress.Location.Easting | integer |
Östlig |
|
Norr
|
Results.RawAddress.Location.Northing | integer |
Norr |
|
GridReference
|
Results.RawAddress.Location.GridReference | string |
GridReference |
|
Longitud
|
Results.RawAddress.Location.Longitude | float |
Longitud |
|
Latitud
|
Results.RawAddress.Location.Latitude | float |
Latitud |
|
CountyCode
|
Results.RawAddress.Location.CountyCode | string |
CountyCode |
|
Region
|
Results.RawAddress.Location.County | string |
Region |
|
DistrictCode
|
Results.RawAddress.Location.DistrictCode | string |
DistrictCode |
|
Distrikt
|
Results.RawAddress.Location.District | string |
Distrikt |
|
WardCode
|
Results.RawAddress.Location.WardCode | string |
WardCode |
|
Ward
|
Results.RawAddress.Location.Ward | string |
Ward |
|
Country
|
Results.RawAddress.Location.Country | string |
Country |
Kontrollera användbart namn
Kontrollera, verifiera och verifiera om ett angivet namn sannolikt är ett verkligt och användbart namn eller om det är oanvändbart, salacious, slumpmässigt eller tomt.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Titel
|
Title | string |
Namnets rubrik |
|
|
Förnamn
|
Forename | string |
Förnamnet på det fullständiga namnet |
|
|
Mellannamn
|
MiddleName | string |
Mellannamnet för det fullständiga namnet |
|
|
Efternamn
|
Surname | string |
Det fullständiga namnets efternamn |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Result
|
Result | string |
Ett tomt värde anger att namnet är ett användbart namn. Om ett värde returneras blir det något av följande: "IncompleteName", "RandomName" eller "SalaciousName" |
PredictiveAddress (detaljnivå)
DrillDown med API:et Data8 PredictiveAddress – Öka detaljnivån ytterligare i sökresultat
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Landskoden iso 2 tecken för sökningen, t.ex. "GB" |
|
Id
|
id | True | string |
Värdeegenskapen från svaret från tidigare begäranden från sök- eller detaljgranskningsmetoderna ska anges här. |
|
IncludeMR
|
IncludeMR | boolean |
Innehåller adresser från databasen Multiple Residency i resultatet (kräver ytterligare licensiering). |
|
|
InkluderaNYB
|
IncludeNYB | boolean |
Innehåller adresser från databasen Som ännu inte har skapats i resultatet (kräver ytterligare licensiering). |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Results
|
Results | array of object |
Results |
|
Etikett
|
Results.label | string |
Värdet som ska visas för användaren. |
|
Värde
|
Results.value | string |
En unik identifierare för matchningen som kan anges till slutpunkterna DrillDown eller Retrieve. |
|
Container
|
Results.container | boolean |
Anger om den här matchning är en container för andra adresser (t.ex. en stad, gata osv.). Om detta är sant ska värdet anges till Slutpunkten Detaljgranskning för att få information om adresserna i containerposten. Om det är falskt ska värdet anges till slutpunkten Hämta för att få fullständig information om adressen. |
|
Föremål
|
Results.items | integer |
En lista över möjliga matchningar. |
|
Räkna
|
Count | integer |
Antalet matchningar som hittas baserat på den angivna informationen. |
|
Session-ID
|
SessionID | string |
Ett SessionID ingår också i svaret. Detta bör ingå i efterföljande anrop till sökslutpunkten. |
PredictiveAddress (Hämta)
Hämta med API:et Data8 PredictiveAddress – Hämta den fullständiga adressen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Landskoden ISO-2 som adressen tillhör. |
|
Id
|
id | True | string |
Värdeegenskapen från svaret från tidigare begäranden från metoderna Search eller DrillDown, när containeregenskapen var false, ska anges här. |
|
MaxLineLength
|
MaxLineLength | integer |
MaxLineLength |
|
|
MaxLines
|
MaxLines | integer |
MaxLines |
|
|
FixTownCounty
|
FixTownCounty | boolean |
FixTownCounty |
|
|
FixPostcode
|
FixPostcode | boolean |
FixPostcode |
|
|
Åtgärda byggnad
|
FixBuilding | boolean |
FixBuilding |
|
|
Oönskadpunctuation
|
UnwantedPunctuation | string |
Oönskadpunctuation |
|
|
Formatter
|
Formatter | string |
Formatter |
|
|
IncludeUDPRN
|
IncludeUDPRN | boolean |
IncludeUDPRN |
|
|
IncludeUPRN
|
IncludeUPRN | boolean |
IncludeUPRN |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Linjer
|
Result.Address.Lines | array of string |
Linjer |
|
Organisation
|
Result.RawAddress.Organisation | string |
Namnet på företaget på adressen |
|
Avdelning
|
Result.RawAddress.Department | string |
Avdelningen inom organisationen på adressen |
|
Adressnyckel
|
Result.RawAddress.AddressKey | integer |
Kombinerar med OrganisationKey och PostcodeType för att tillhandahålla en unik nyckel för den här adressen |
|
OrganisationKey
|
Result.RawAddress.OrganisationKey | integer |
Kombineras med AddressKey och PostcodeType för att tillhandahålla en unik nyckel för den här adressen. Kommer att vara 0 för bostadsadresser |
|
PostcodeType
|
Result.RawAddress.PostcodeType | string |
Anger om adressen finns på en "liten användare" ("S") eller "stor användare" ("L"). Ett stort postnummer för användare är ett som allokeras till en enskild organisation som en tung e-postanvändare, t.ex. DVLA |
|
BuildingNumber
|
Result.RawAddress.BuildingNumber | integer |
Husets nummer för adressen. Observera att detta endast är ett heltalsnummer. Byggnadsnummer som 12A visas i fältet BuildingName |
|
SubBuildingName
|
Result.RawAddress.SubBuildingName | string |
Namnet på underbyggnaden för adressen. Detta är vanligtvis ett lägenhets- eller lägenhetsnummer |
|
BuildingName
|
Result.RawAddress.BuildingName | string |
Namnet på byggnaden. Kan innehålla nummerinformation där talet inte är ett enkelt heltal |
|
DependentThoroughfareName
|
Result.RawAddress.DependentThoroughfareName | string |
Namnet på den beroende genomfartsleder, dvs en mindre gata utanför en större gata |
|
DependentThoroughfareDesc
|
Result.RawAddress.DependentThoroughfareDesc | string |
Beskrivningen ("gata", "väg" osv.) för den beroende genomfartsleden |
|
ThoroughfareName
|
Result.RawAddress.ThoroughfareName | string |
Namnet på huvudgatan |
|
ThoroughfareDesc
|
Result.RawAddress.ThoroughfareDesc | string |
Beskrivningen av huvudgatan |
|
DoubleDependentLocality
|
Result.RawAddress.DoubleDependentLocality | string |
Namnet på den dubbelberoende orten – lokaliteten på tredje nivån |
|
DependentLocality
|
Result.RawAddress.DependentLocality | string |
Namnet på den beroende orten – lokaliteten på andra nivån |
|
Lokalitet
|
Result.RawAddress.Locality | string |
Namnet på poststaden på den översta nivån |
|
Postnummer
|
Result.RawAddress.Postcode | string |
Postnumret i ett fast format på 7 tecken |
|
DPS
|
Result.RawAddress.Dps | string |
Suffixet med två teckens leveranspunkt som unikt identifierar adressen i postnumret |
|
Pobox
|
Result.RawAddress.PoBox | string |
Information om PO Box om adressen är en PO Box-adress |
|
PostalCounty
|
Result.RawAddress.PostalCounty | string |
Det länsnamn som ska visas i adressen |
|
TraditionalCounty
|
Result.RawAddress.TraditionalCounty | string |
Det länsnamn som traditionellt var associerat med adressen men som nu inte är postalt obligatoriskt |
|
AdministrativeCounty
|
Result.RawAddress.AdministrativeCounty | string |
Det län som adressen finns i i i administrativt syfte men som inte är postalt obligatoriskt |
|
CountryISO2
|
Result.RawAddress.CountryISO2 | string |
Iso-landskoden med två tecken som är relaterad till adressen. Detta fylls inte i av AddressCapture-tjänsten |
|
UniqueReference
|
Result.RawAddress.UniqueReference | string |
Ett alternativt unikt referensnummer för adressen. Detta anges till UDPRN-numret för adressen genom att ange alternativet IncludeUDPRN till metoden |
|
Östlig
|
Result.RawAddress.Location.Easting | integer |
Avståndet för postnumret öster om OS-rutnätets ursprung sydväst om Scilly |
|
Norr
|
Result.RawAddress.Location.Northing | integer |
Avståndet för postnumret norr om OS-rutnätets ursprung |
|
GridReference
|
Result.RawAddress.Location.GridReference | string |
Platsen för postnumret som en 6-siffrig OS-rutnätsreferens |
|
Longitud
|
Result.RawAddress.Location.Longitude | float |
Longitud för postnumret uttryckt i decimalgrader i WGS84-datumet |
|
Latitud
|
Result.RawAddress.Location.Latitude | float |
Latitud för postnumret uttryckt i decimalgrader i WGS84-datum |
|
CountyCode
|
Result.RawAddress.Location.CountyCode | string |
Länskoden som ska visas i adressen |
|
Region
|
Result.RawAddress.Location.County | string |
Det länsnamn som ska visas i adressen |
|
DistrictCode
|
Result.RawAddress.Location.DistrictCode | string |
Distriktskoden som ska visas i adressen |
|
Distrikt
|
Result.RawAddress.Location.District | string |
Det distrikt som ska visas på adressen |
|
WardCode
|
Result.RawAddress.Location.WardCode | string |
Referenskoden för den avdelning som postnumret finns i |
|
Ward
|
Result.RawAddress.Location.Ward | string |
Namnet på valföreståndaren postnumret finns i |
|
Country
|
Result.RawAddress.Location.Country | string |
Iso-landskoden med två tecken som är relaterad till adressen. |
|
Ytterligare data
|
Result.RawAddress.AdditionalData | string |
Eventuella ytterligare data som returneras |
PredictiveAddress (sök)
Söka med API:et Data8 PredictiveAddress – Sök efter en partiell adress i våra många datakällor
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Landskoden ISO-2 som adressen tillhör. |
|
Sökning
|
search | True | string |
Den partiella adress som angetts av användaren. |
|
Telefonnummer
|
telephoneNumber | string |
En valfri parameter, telefonnumret som är associerat med adressen kan anges. |
|
|
Session
|
session | string |
Sessions-ID:t som togs emot i föregående svar. Detta förbättrar effektiviteten och uppslagshastigheten. Detta bör ingå i efterföljande anrop till sökslutpunkten. |
|
|
IncludeMR
|
IncludeMR | boolean |
Innehåller adresser från databasen Multiple Residency i resultatet (kräver ytterligare licensiering). |
|
|
InkluderaNYB
|
IncludeNYB | boolean |
Innehåller adresser från databasen Som ännu inte har skapats i resultatet (kräver ytterligare licensiering). |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Results
|
Results | array of object |
Results |
|
Etikett
|
Results.label | string |
Värdet som ska visas för användaren. |
|
värde
|
Results.value | string |
värde |
|
Container
|
Results.container | boolean |
Anger om den här matchning är en container för andra adresser (t.ex. en stad, gata osv.). Om detta är sant ska värdet anges till Slutpunkten Detaljgranskning för att få information om adresserna i containerposten. Om det är falskt ska värdet anges till slutpunkten Hämta för att få fullständig information om adressen. |
|
Föremål
|
Results.items | integer |
En lista över möjliga matchningar. |
|
Räkna
|
Count | integer |
Räkna |
|
Session-ID
|
SessionID | string |
Ett SessionID ingår också i svaret. Detta bör ingå i efterföljande anrop till sökslutpunkten. |
Rensa adress
Formaterar, verifierar och korrigerar en viss adress till en fullständig formaterad adress.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Linjer
|
Lines | True | array of string |
Linjer |
|
Standard landskod
|
DefaultCountryCode | string |
En ISO 2-teckenkod för landet att anta att adressen finns i om inget annat anges. Detta är som standard GB. |
|
|
Identifiera land automatiskt
|
DetectCountry | boolean |
Ställ in på true för att försöka identifiera landet automatiskt från den angivna adressinformationen, vilket kan åsidosätta standardlandet |
|
|
Country
|
Country | string |
Om DetectCountry är inställt på true används detta som ytterligare användarindata tillsammans med adressen för att påverka funktionen för landsidentifiering. Formatet för detta tillämpas inte, så det kan anges som "USA", "USA" eller "USA" |
|
|
Inkludera land
|
IncludeCountry | boolean |
Innehåller fältet CountryName i huvuddelen av resultatet |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Linjer
|
Result.Address.Lines | array of string |
Linjer |
|
Matchningsnivå
|
MatchLevel | string |
Innehåller en MatchLevel för att ange hur väl adressen matchade TILL PAF. Möjliga värden är OK_Unchanged, OK_Corrected, NOK_Building, NOK_Street, NOK_Town, NOK_NoMatch |
|
Namn på land
|
CountryName | string |
Innehåller namnet på det land som adressen finns i. |
Rensa e-post
Rensa en e-postadress, verifiera den för att se om det är ett riktigt, äkta e-postmeddelande men ta också ytterligare information som ett namn eller företagsnamn för att berika ytterligare
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
E-postadress
|
True | string |
Den e-postadress som du vill verifiera |
|
|
Nivå
|
Level | True | string |
Den nivå som du vill verifiera. Detta bör alltid finnas i brödtexten i begäran, aldrig i URL:en och aldrig i frågeparametrarna. Om du är osäker, standardvärdet server" |
|
Titel
|
Title | string |
Rubriken eller hälsningen för det angivna namnet används för att avgöra om e-postadressen är giltig och korrekt |
|
|
Förnamn
|
Forename | string |
Förnamnet på det angivna namnet används för att avgöra om e-postadressen är giltig och korrekt |
|
|
Mellannamn
|
MiddleName | string |
Mellannamnet på det angivna namnet används för att avgöra om e-postadressen är giltig och korrekt |
|
|
Surname
|
Surname | string |
Efternamnet på det angivna namnet används för att avgöra om e-postadressen är giltig och korrekt |
|
|
Företag
|
Company | string |
Namnet på företaget som hjälper dig att identifiera om e-postmeddelandet är korrekt |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
CreditsRemaining
|
Status.CreditsRemaining | integer |
Återstående Data8-krediter för den anropade tjänsten |
|
Result
|
Result | string |
Innehåller en statuskod som anger om e-postadressen kan verifieras. |
|
OriginalValid
|
OriginalValid | boolean |
OriginalValid |
|
E-posttyp
|
EmailType | string |
Typen av e-post för den angivna och hur den klassificeras |
|
Föreslagen e-postadress
|
SuggestedEmailAddress | string |
En föreslagen e-postadress för att förbättra det här e-postmeddelandet, om ett sådant anges bör visas så att användaren har möjlighet att välja att använda den. |
|
Comment
|
Comment | string |
En hjälpkommentar om varför en rekommendation har gjorts för att ge ytterligare kontext |
|
Hälsningsfras
|
Salutation | string |
Den hälsning som kan användas med det här e-postmeddelandet – dvs. vem som ska adressera e-postmeddelandet till. |
|
StructureUsed
|
StructureUsed | string |
StructureUsed |
|
ParsedName
|
ParsedName | string |
ParsedName |
TPS-kontroll
Kontrollerar om ett telefonnummer är registrerat på TPS eller inte.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Telefonnummer
|
number | True | string |
Det telefonnummer som du vill kontrollera |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Är anropsbar
|
Callable | boolean |
Returnerar ett booleskt värde som låter dig veta om det kan anropas. Om det är falskt finns numret för närvarande på TPS. |
|
Telefonnummer
|
TelephoneNumber | string |
Returnerar telefonnumret om det går att ringa, null om inte. |
Verifiera bankkontoinformation
Kontrollera om en sorteringskod och bankkontonummer är giltiga.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sortera kod
|
sortCode | True | string |
Den sorteringskod som du vill verifiera |
|
Bankkontonummer
|
bankAccountNumber | string |
Det bankkontonummer som du vill verifiera |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Giltigt
|
Valid | string |
Anger om den inkommande sorteringskoden och bankkontonumret kan verifieras. |
|
Sortera kod
|
SortCode | string |
Den sorteringskod som har verifierats. |
|
Kontonummer
|
AccountNumber | string |
Det kontonummer som har verifierats. |
|
BIC-kod
|
BICCode | string |
BIC-koden för bankgrenen som anges av sorteringskoden. |
|
IBAN
|
IBAN | string |
IBAN-koden för bankkontot som anges av sorteringskoden och kontonumret. |
|
Grennamn
|
BranchName | string |
Namnet på bankgrenen som anges av sorteringskoden. |
|
Kort banknamn
|
ShortBankName | string |
Ett kort namn för banken som anges av sorteringskoden. |
|
Fullständigt banknamn
|
FullBankName | string |
Det fullständiga namnet på banken som anges av sorteringskoden. |
|
Linjer
|
Address.Address.Lines | array of string |
Linjer |
|
Accepterar BACS-betalningar
|
AcceptsBACSPayments | boolean |
Anger om bankgrenen kan acceptera betalningar som görs via BACS-systemet. |
|
Accepterar autogirotransaktioner
|
AcceptsDirectDebitTransactions | boolean |
Anger om bankgrenen kan acceptera direktdebiteringsbetalningar. |
|
Accepterar direkta kredittransaktioner
|
AcceptsDirectCreditTransactions | boolean |
Anger om bankgrenen kan acceptera direkta kreditbetalningar. |
|
Accepterar obetalda checkanspråkstransaktioner
|
AcceptsUnpaidChequeClaimTransactions | boolean |
Anger om bankgrenen kan acceptera anspråk på obetalda checkar. |
|
Accepterar kredittransaktioner för byggsamhället
|
AcceptsBuildingSocietyCreditTransactions | boolean |
Anger om bankgrenen kan ta emot krediter från byggföretag. |
|
Accepterar betalningstransaktioner med utdelningsränta
|
AcceptsDividendInterestPaymentTransactions | boolean |
Anger om bankgrenen kan acceptera ränteutbetalningar för utdelning. |
|
Accepterar direktdebiteringsinstruktionstransaktioner
|
AcceptsDirectDebitInstructionTransactions | boolean |
Anger om bankgrenen kan acceptera autogiroinstruktioner. |
|
Accepterar CHAPS-betalningar
|
AcceptsCHAPSPayments | boolean |
Anger om bankgrenen kan acceptera betalningar som görs via CHAPS-systemet. |
|
Accepterar checkar
|
AcceptsCheques | boolean |
Anger om bankgrenen kan acceptera betalningar som görs med check. |
|
Accepterar snabbare betalningar
|
AcceptsFasterPayments | boolean |
Anger om bankgrenen kan acceptera snabbare betalningar. |
Verifiera e-postadress
Kontrollera, verifiera och kontrollera om en e-postadress är giltig, verklig och skulle få e-post om den skickades en. Detta fungerar som en e-postverifieringstjänst i realtid.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
E-postadress
|
True | string |
Den e-postadress som du vill verifiera |
|
|
Valideringsnivå
|
level | True | string |
Den nivå som du vill verifiera. Om du är osäker är standardvärdet Server |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Result
|
Result | string |
Innehåller en statuskod som anger om e-postadressen kan verifieras. Mer information om den möjliga statuskoden finns i https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid |
Verifiera telefonnummer
Kontrollerar om ett telefonnummer är giltigt för att ta emot ett telefonsamtal. Den kontrollerar telefonlinjens aktuella status i realtid och returnerar ett svar.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Telefonnummer
|
telephoneNumber | True | string |
Det tal som du vill verifiera |
|
Standard landskod
|
defaultCountry | True | integer |
ISO 3166-1-Alpha-2 ISO2 landskod för att kontrollera. Om det här värdet inte anges använder du de aktuella användarnas ISO 3166-1-Alpha-2-kod |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Telefonnummer
|
Result.TelephoneNumber | string |
Det inmatade telefonnumret formaterat |
|
Valideringsresultat
|
Result.ValidationResult | string |
Det enkla resultatet för valideringen av telefonnumret |
|
Valideringsnivå
|
Result.ValidationLevel | string |
Valideringsnivån som hittades för telefonnumret. |
|
Nummertyp
|
Result.NumberType | string |
Anger typen av angivet nummer, dvs. Fast eller Mobil |
|
Plats
|
Result.Location | string |
Aktuell plats för telefonnumret om det är tillgängligt |
|
Provider
|
Result.Provider | string |
Telefonnumrets nätleverantör |
|
Landskod
|
Result.CountryCode | string |
Lands-ISO2-kod för telefonnumret |
|
Namn på land
|
Result.CountryName | string |
Telefonnumrets landsnamn |
Verifiera telefonnummer (inaktuellt)
Kontrollerar om en inmatad e-postadress är giltig för att ta emot e-post – detta är inaktuellt till förmån för PhoneValidation
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Telefonnummer
|
telephoneNumber | True | string |
Det tal som du vill verifiera |
|
Standard landskod
|
defaultCountry | True | string |
Formaterat som tal, t.ex. 44 för Storbritannien |
|
Använda radverifiering
|
UseLineValidation | boolean |
Om värdet är true använder tjänsten Data8 LandlineValidation på ett tal som identifieras som ett brittiskt fast telefonnummer och InternationalTelephoneValidation på alla andra nummer. Alla valideringsanrop debiteras antingen en InternationalTelephoneValidation-kredit eller en LandlineValidation-kredit i enlighet med detta, så se till att du har fastavalidationskrediter tillgängliga innan du använder det här alternativet. Alternativet är som standard falskt. |
|
|
Använda mobilvalidering
|
UseMobileValidation | boolean |
Om värdet är true använder tjänsten Data8 MobileValidation på ett tal som identifieras som ett mobilnummer och InternationalTelephoneValidation på alla andra nummer. Alla valideringsanrop debiteras antingen en InternationalTelephoneValidation-kredit eller en MobileValidation-kredit, så se till att du har MobileValidation-krediter tillgängliga innan du använder det här alternativet. Alternativet är som standard falskt. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Flagga för att avgöra om begäran till Data8 lyckades, oavsett resultat |
|
Felmeddelande
|
Status.ErrorMessage | string |
Returnerat felmeddelande, om det finns något |
|
Återstående krediter
|
Status.CreditsRemaining | float |
Återstående Data8-krediter för den anropade tjänsten |
|
Telefonnummer
|
Result.TelephoneNumber | string |
Det inmatade telefonnumret formaterat |
|
Valideringsresultat
|
Result.ValidationResult | string |
Det enkla resultatet för valideringen av telefonnumret |
|
Valideringsnivå
|
Result.ValidationLevel | string |
Valideringsnivån som hittades för telefonnumret. |
|
Nummertyp
|
Result.NumberType | string |
Anger typen av angivet nummer, dvs. Fast eller Mobil |
|
Plats
|
Result.Location | string |
Aktuell plats för telefonnumret om det är tillgängligt |
|
Provider
|
Result.Provider | string |
Telefonnumrets nätleverantör |
|
Landskod
|
Result.CountryCode | string |
Lands-ISO2-kod för telefonnumret |
|
Namn på land
|
Result.CountryName | string |
Telefonnumrets landsnamn |
Är avliden
Storbritannien – Identifiera avlidna individer snabbt och enkelt med hjälp av trovärdiga källor som uppdateras regelbundet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Titel
|
Title | string |
Namnet på det namn som ska sökas |
|
|
Förnamn
|
Forename | string |
Förnamnet på namnet som ska sökas |
|
|
Mellannamn
|
MiddleName | string |
Mellannamnet på det namn som ska sökas |
|
|
Surname
|
Surname | True | string |
Namnets efternamn att söka efter |
|
Linjer
|
Lines | True | array of string |
Linjer |
|
Marknadsföring
|
marketing | True | boolean |
Ett booleskt värde för att avgöra om sökningen görs av marknadsföringsskäl eller inte. |
|
Matchningsnivå
|
MatchLevel | string |
Den minsta matchningsnivån mellan det namn som anges i indataposten och namnet i våra referensdatafiler. S är efternamn, jag är initial och F är förnamn |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Success |
|
Felmeddelande
|
Status.ErrorMessage | string |
Felmeddelande (om tillämpligt) |
|
CreditsRemaining
|
Status.CreditsRemaining | float |
Återstående krediter |
|
Är avliden
|
Result | boolean |
Anger om personen är avliden |