ID Analyzer (preview)
ID Analyzer biedt verschillende producten voor identiteitsverificatie. U moet basiskennis van elk product verkrijgen om de beste oplossing voor uw toepassing te kiezen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Ondersteuning voor ID Analyzer |
| URL | https://www.idanalyzer.com/contact.html |
| E-mailen | support@idanalyzer.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Evith Techology |
| Webpagina | https://www.idanalyzer.com/ |
| Privacybeleid | https://www.idanalyzer.com/privacy-policy.html |
| Categorieën | IT-bewerkingen; Productiviteit |
Het ID Analyzer-platform biedt bedrijven, organisaties en personen een echte wereldwijde oplossing voor identiteitsverificatie die zonder grenzen werkt, een oplossing die kan worden afgestemd op uw specifieke behoeften en eisen, en een beveiligingssysteem dat voortdurend wordt bijgewerkt en verbeterd.
Het bieden van volledige toegang tot identiteitsverificatie en informatie in meer dan 4000+ verschillende vormen van id in 190+ landen over de hele wereld, is dit zeer een wereldwijde oplossing die is ontworpen met de moderne wereld in gedachten.
Vereiste voorwaarden
- Een ontwikkelaarsaccount met ID Analyzer. U kunt zich registreren voor een gratis account bij Registreren
- Nadat u zich hebt geregistreerd voor het account, krijgt u een API-sleutel in de webportal van ID Analyzer. Gebruik deze API-sleutel om te verifiëren met de connector
Referenties ophalen
- Ga naar Registreren
- Voer de vereiste gegevens in.
- Controleer uw e-mail wanneer u hierom wordt gevraagd.
- U ziet uw nieuwe API-sleutel in de webportal van ID Analyzer met uw accountgegevens. Druk op de knop Kopiëren om het op het Klembord op te slaan voor later gebruik.
Veelgestelde vragen
Ik maak me zorgen over privacy van mijn klant, slaat de API informatie over mijn klant op?
Alles wordt alleen opgeslagen in de kluis van de client en wordt niet willekeurig gelekt. Er is geen kopie aanwezig.
Wat zijn de 'tegoeden' voor, hoe kan ik API-tegoed kopen?
Resterend vooruitbetaald tegoed voor uw account. Als u een maandelijks abonnement hebt, wordt uw maandelijkse quotum gebruikt vóór vooraf betaald tegoed.
Hoe controleer ik of een document echt of nep is?
Schakel verificatie in. Het resultaat bevat de verificatiescore.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| API-sleutel | beveiligde string | De API-sleutel voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Afbeelding toevoegen aan kluis |
U kunt een afbeelding uploaden en toevoegen aan een bestaande kluisvermelding door een HTTP POST-aanvraag te maken. |
| Afbeelding verwijderen uit kluis |
U kunt een afbeelding in een kluisvermelding verwijderen door een HTTP POST-aanvraag te maken. Nadat een afbeelding is verwijderd, is de URL naar de afbeelding mogelijk nog steeds gedurende korte tijd toegankelijk vanwege caching. |
| Callback valideren |
Om ervoor te zorgen dat de gegevens zijn verzonden vanaf onze server. |
|
Docu |
U kunt een verificatiesessie maken voor elke gebruiker die identiteitsverificatie vereist. |
|
Docu |
U kunt een handtekeningsessie maken waarin de gebruiker het juridische document controleert en e-ondertekent zonder identiteitsverificatie. Als u zowel identiteitsverificatie wilt uitvoeren als uw gebruiker een document wilt ondertekenen, maakt u in plaats daarvan een sessie voor identiteitsverificatie. |
| Face Search-training |
Voordat u gezichtszoekopdrachten uitvoert, moet u een trainopdracht uitvoeren om de documentgegevenssets in uw kluis te trainen. U kunt uw kluisgegevens ook trainen via de webportal. De trainingstaak is asynchroon, trainingstijd is afhankelijk van het aantal kluisvermeldingen en installatiekopieën. Het kan enkele seconden tot een uur duren. |
| Inhoud van kluisvermelding ophalen |
Wanneer vermeldingen worden toegevoegd aan de kluis, retourneren zowel De Core-API als de DocuPass-API een kluisvermeldings-id met de naam vaultid. U kunt de id gebruiken om een query uit te voeren op de inhoud van een vermelding in de kluis door een HTTP POST-aanvraag in te dienen bij het volgende eindpunt. |
| Kern-API-instelling |
Verificatie-API voor meervoudige id's om extern fysiek document te verifiëren, de authenticiteit en het gezicht komen overeen met het document met uw gebruikersfoto. |
| Kluisvermelding bijwerken |
U kunt de waarde van één veld of waarden van meerdere velden in een kluisvermelding bijwerken door een HTTP POST-aanvraag te maken. |
| Lijst- en filtervermeldingen |
Als u alle vermeldingen wilt weergeven die zijn opgeslagen in de kluis of zoekt naar vermeldingen met specifieke waarden, verzendt u een HTTP POST-aanvraag naar het volgende eindpunt. |
| Trainingsstatus |
Controleer of de kluistraining nog steeds actief is of is voltooid. |
| Vermelding uit kluis verwijderen |
U kunt enkele of meerdere kluisvermeldingen verwijderen door een HTTP POST-aanvraag te maken. |
| Zoeken in AML-database |
Met de AML-API kunt u de globale AML-database van ID Analyzer doorzoeken op sancties, PSP's en gewilde criminelen met behulp van een naam, documentnummer of beide. U kunt de resultaten verder filteren met verjaardag en nationaliteit. |
| Zoeken naar gezichten |
Met Face Search kunt u de hele kluis doorzoeken met behulp van een afbeelding van een persoon. Als u de functie voor gezichtszoekopdrachten wilt gebruiken, moet u indexering voor facezoekopdrachten inschakelen via de webportal en uw kluisgegevenssets periodiek trainen. |
Afbeelding toevoegen aan kluis
U kunt een afbeelding uploaden en toevoegen aan een bestaande kluisvermelding door een HTTP POST-aanvraag te maken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
identiteitskaart
|
id | True | string |
De id van de kluisvermelding waaraan u een afbeelding wilt toevoegen |
|
type
|
type | True | string |
Het type afbeelding instellen: 0=document en 1=persoon |
|
image
|
image | string |
Met Base64 gecodeerde afbeeldingsgegevens. |
|
|
imageurl
|
imageurl | string |
URL voor externe installatiekopieën. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | integer | |
|
identiteitskaart
|
image.id | string |
Afbeeldings-id |
|
type
|
image.type | string |
0 voor document en 1 voor persoon |
|
hekje
|
image.hash | string |
MD5-hash van installatiekopieën |
|
url
|
image.url | string |
URL naar de afbeelding |
|
createtime
|
image.createtime | string |
Tijdafbeelding is geüpload in UTC |
Afbeelding verwijderen uit kluis
U kunt een afbeelding in een kluisvermelding verwijderen door een HTTP POST-aanvraag te maken. Nadat een afbeelding is verwijderd, is de URL naar de afbeelding mogelijk nog steeds gedurende korte tijd toegankelijk vanwege caching.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
identiteitskaart
|
id | True | string |
De id van de kluisvermelding die de afbeelding bevat. |
|
imageid
|
imageid | string |
id van de afbeelding die u wilt verwijderen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | integer |
Callback valideren
Om ervoor te zorgen dat de gegevens zijn verzonden vanaf onze server.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in uw webportal. |
|
referentie
|
reference | True | string |
Referentiecode die is ontvangen in POST BODY. |
|
hekje
|
hash | True | string |
Hash ontvangen in POST BODY. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | boolean | |
|
referentie
|
reference | string |
Referentiecode voor de DocuPass-sessie |
DocuPass-sessie maken
U kunt een verificatiesessie maken voor elke gebruiker die identiteitsverificatie vereist.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in uw webportal. |
|
type
|
type | integer |
0: Iframe Module ,1: Mobiele module, 2: Omleidingsmodule, 3: Live Mobile Module |
|
|
bedrijfsnaam
|
companyname | True | string |
De naam van uw bedrijf of product. |
|
callbackurl
|
callbackurl | string |
Webhook/Callback-URL voor het ontvangen van verificatieresultaten. |
|
|
biometrisch
|
biometric | integer |
Vraag de gebruiker om een selfiefoto of selfievideo te maken voor gezichtsverificatie. |
|
|
biometric_threshold
|
biometric_threshold | float |
Geef de minimale score op om gezichtsbiometrieverificatie door te geven |
|
|
authenticate_minscore
|
authenticate_minscore | float |
Het document moet voldoen aan de minimale authenticiteitsscore om validatie te kunnen doorstaan. Stel 0 in om geldigheid/echtheidscontrole uit te schakelen. |
|
|
authenticate_module
|
authenticate_module | integer |
Geef de module op die wordt gebruikt voor het valideren van het document. |
|
|
maxattempt
|
maxattempt | integer |
Het aantal mislukte pogingen voor elke verificatieaanvraag. |
|
|
successredir
|
successredir | string |
De browser wordt omgeleid naar deze URL wanneer de identiteitsverificatie slaagt. |
|
|
failredir
|
failredir | string |
Browser wordt omgeleid naar deze URL wanneer identiteitsverificatie is mislukt. |
|
|
customid
|
customid | string |
Het is handig voor het identificeren van uw gebruiker in uw database. Deze waarde wordt opgeslagen onder docupass_customid onder Kluis. |
|
|
herbruikbaar
|
reusable | boolean |
Als u deze parameter inschakelt, kunnen meerdere gebruikers hun identiteit verifiëren via dezelfde URL. Er wordt automatisch een nieuwe DocuPass-referentiecode gegenereerd voor elke gebruiker. |
|
|
fonetische verificering
|
phoneverification | boolean |
Of de gebruiker een telefoonnummer moet invoeren voor verificatie, ondersteunt DocuPass zowel verificatie van mobiele nummers als vaste nummers. (Alleen abonnee) |
|
|
documenttype
|
documenttype | string |
De gebruiker moet een specifiek type document uploaden. Zo accepteert 'PD' zowel paspoort- als rijbewijs. |
|
|
documentcountry
|
documentcountry | string |
ISO ALPHA-2-landcode. |
|
|
documentregio
|
documentregion | string |
Volledige naam of afkorting van staat/regio. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Controleer of de namen, het documentnummer en het documenttype overeenkomen tussen de voor- en achterkant van het document bij het uitvoeren van dubbele scanbewerkingen. Als er informatie niet overeenkomt met fout 14, wordt fout 14 gegenereerd. |
|
|
verify_expiry
|
verify_expiry | boolean |
Alleen document accepteren dat niet is verlopen |
|
|
verify_documentno
|
verify_documentno | string |
Documentnummer dat verificatie vereist. |
|
|
verify_name
|
verify_name | string |
Volledige naam, inclusief voornaam en achternaam waarvoor verificatie is vereist. |
|
|
verify_dob
|
verify_dob | string |
Geboortedatum waarvoor verificatie is vereist, in de notatie JJJJ/MM/DD. |
|
|
verify_age
|
verify_age | string |
Leeftijdsbereik, voorbeeld: 18-40 |
|
|
verify_address
|
verify_address | string |
Volledig adres waarvoor verificatie is vereist. |
|
|
verify_postcode
|
verify_postcode | string |
Volledige postcode die verificatie vereist. |
|
|
verify_phone
|
verify_phone | string |
Volledig telefoonnummer waarvoor verificatie is vereist. |
|
|
vault_save
|
vault_save | boolean |
Sla gebruikersdocumenten en geparseerde informatie op in de kluis. |
|
|
return_documentimage
|
return_documentimage | boolean |
Retourneer een documentafbeelding die is geüpload door de gebruiker in de callback-aanvraag. |
|
|
return_faceimage
|
return_faceimage | boolean |
Retourgezichtafbeelding die is geüpload door de gebruiker in de callback-aanvraag. |
|
|
return_type
|
return_type | integer |
Geef het type afbeelding op dat wordt geretourneerd, ofwel base64-gecodeerde afbeeldingsinhoud of een URL naar de afbeelding. (URL naar afbeelding wordt slechts 7 dagen bewaard) |
|
|
welcomemessage
|
welcomemessage | string |
Vervang het algemene begroetingsbericht op de eerste pagina door de aangepaste tekst (maximaal 1000 tekens) |
|
|
nobranding
|
nobranding | boolean |
Merklogo verbergen op alle DocuPass-pagina's. (Alleen abonnee) |
|
|
logo
|
logo | string |
Aangepast huisstijllogo. (Alleen abonnee) |
|
|
customhtmlurl
|
customhtmlurl | string |
Gebruik uw eigen HTML-pagina en CSS voor DocuPass. (Alleen abonnee) |
|
|
language
|
language | string |
DocuPass detecteert automatisch de taal van het gebruikersapparaat en geeft de bijbehorende taal weer. |
|
|
vervaldatum
|
expiry | integer |
Aantal seconden voordat de DocuPass-sessie verloopt. Na verloop van tijd kan de gebruiker niet doorgaan met de huidige sessie, wordt er ook een mislukte callback verzonden. |
|
|
qr_color
|
qr_color | string |
Kleur van de QR-code voorgrond. (Alleen voor Live Mobile en Standard Mobile) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Kleur van de QR-codeachtergrond. (Alleen voor Live Mobile en Standard Mobile) |
|
|
qr_size
|
qr_size | integer |
Grootte van QR-code (1-50). (Alleen voor Live Mobile en Standard Mobile) |
|
|
qr_margin
|
qr_margin | integer |
Randdikte van QR-code (1-50). (Alleen voor Live Mobile en Standard Mobile) |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
referentie
|
reference | string |
Een unieke referentiecode voor de DocuPass-sessie. |
|
type
|
type | integer |
DocuPass-moduletype gemaakt. |
|
customid
|
customid | string |
Aangepaste id die wordt gebruikt bij het maken van een DocuPass-sessie. |
|
url
|
url | string |
Unieke URL voor DocuPass-web-app. Verzend deze koppeling naar uw gebruiker of sluit deze in uw website of mobiele app in om identiteitsverificatie te starten. |
|
qrcode
|
qrcode | string |
URL van QR-codeafbeelding voor uw gebruiker om te scannen |
|
base_url
|
base_url | string |
U kunt deze koppeling naar uw gebruiker verzenden en hen vragen om referentiecode in te voeren om verificatie te starten. |
|
html
|
html | string |
Voorbeeld-HTML die u in uw webpagina kunt invoegen. |
|
smssent
|
smssent | integer |
Bevat het telefoonnummer als bevestiging wanneer sms is verzonden via sms_verification_link parameter. |
|
vervaldatum
|
expiry | integer |
UTC UNIX-tijdstempel die aangeeft wanneer deze sessie verloopt, kan de gebruiker de koppeling niet meer gebruiken en er wordt een mislukte callback verzonden. |
DocuPass Signature-sessie maken
U kunt een handtekeningsessie maken waarin de gebruiker het juridische document controleert en e-ondertekent zonder identiteitsverificatie. Als u zowel identiteitsverificatie wilt uitvoeren als uw gebruiker een document wilt ondertekenen, maakt u in plaats daarvan een sessie voor identiteitsverificatie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in uw webportal. |
|
bedrijfsnaam
|
companyname | True | string |
Uw bedrijfsnaam wordt weergegeven op de verificatiepagina, zodat eindgebruikers weten dat ze identiteitsgegevens naar uw bedrijf verzenden |
|
template_id
|
template_id | string |
Contractsjabloon-id voor automatisch doorvoeren met gebruikersgegevens. |
|
|
contract_format
|
contract_format | string |
Uitvoerdocumentindeling. (PDF, DOCX, HTML) |
|
|
callbackurl
|
callbackurl | string |
Het contractbestand wordt naar deze URL verzonden. U moet vault_save inschakelen of een callbackurl opgeven, zodat u het gegenereerde document kunt opslaan. |
|
|
successredir
|
successredir | string |
De browser wordt omgeleid naar deze URL nadat het document is gecontroleerd en ondertekend. DocuPass-referentiecode en customid worden toegevoegd aan het einde van de URL |
|
|
customid
|
customid | string |
Een aangepaste tekenreeks die wordt teruggestuurd naar de callback-URL van uw server en toegevoegd aan omleidings-URL's die zijn ingesteld door successredir en failredir als een querytekenreeks. Het is handig voor het identificeren van uw gebruiker in uw database. Deze waarde wordt opgeslagen onder docupass_customid onder Kluis. |
|
|
herbruikbaar
|
reusable | boolean |
Als u deze parameter inschakelt, kunnen meerdere gebruikers documenten controleren en ondertekenen via dezelfde URL. Er wordt automatisch een nieuwe DocuPass-referentiecode gegenereerd voor elke gebruiker. |
|
|
sms_contract_link
|
sms_contract_link | string |
Volledig internationaal mobiel nummer |
|
|
vault_save
|
vault_save | boolean |
Gegenereerd document opslaan in kluis. U moet vault_save inschakelen of een callbackurl opgeven, zodat u het gegenereerde document kunt opslaan. |
|
|
nobranding
|
nobranding | boolean |
Merklogo verbergen op alle DocuPass-pagina's. |
|
|
customhtmlurl
|
customhtmlurl | string |
Gebruik uw eigen HTML-pagina en CSS voor DocuPass. Nadat u wijzigingen hebt aangebracht in de HTML en CSS die u naar uw eigen server moet uploaden, downloadt DocuPass aan het begin van elke sessie de meest recente HTML-pagina van uw server. |
|
|
language
|
language | string |
DocuPass detecteert automatisch de taal van het gebruikersapparaat en geeft de bijbehorende taal weer. Stel deze parameter in om automatische taaldetectie te overschrijven. (nl, nl, de, es, zh-TW, zh-CN) |
|
|
vervaldatum
|
expiry | integer |
Aantal seconden voordat de DocuPass-sessie verloopt. Na verloop van tijd kan de gebruiker niet doorgaan met de huidige sessie, wordt er ook een mislukte callback verzonden. |
|
|
qr_color
|
qr_color | string |
Kleur van de QR-code voorgrond |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Kleur van de QR-codeachtergrond |
|
|
qr_size
|
qr_size | integer |
Grootte van QR-code |
|
|
qr_margin
|
qr_margin | integer |
Randdikte van QR-code |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
referentie
|
reference | string |
Een unieke referentiecode voor de DocuPass-sessie. |
|
customid
|
customid | string |
Aangepaste id die wordt gebruikt bij het maken van een DocuPass-sessie. |
|
url
|
url | string |
Unieke URL voor DocuPass-web-app. Verzend deze koppeling naar uw gebruiker of sluit deze in uw website of mobiele app in om het document te controleren en te ondertekenen. |
|
qrcode
|
qrcode | string |
URL van QR-codeafbeelding voor uw gebruiker om te scannen |
|
base_url
|
base_url | string |
U kunt deze koppeling naar uw gebruiker verzenden en hen vragen om referentiecode in te voeren om documenten te ondertekenen. |
|
html_qrcode
|
html_qrcode | string |
Voorbeeld-HTML om QR-code weer te geven op uw webpagina. |
|
html_iframe
|
html_iframe | string |
Voorbeeld-HTML om iframe in te voegen op uw webpagina. |
|
smssent
|
smssent | string |
Bevat het telefoonnummer als bevestiging wanneer sms is verzonden via sms_contract_link parameter. |
|
vervaldatum
|
expiry | integer |
UTC UNIX-tijdstempel die aangeeft wanneer deze sessie verloopt, kan de gebruiker de koppeling niet meer gebruiken en er wordt een mislukte callback verzonden. |
Face Search-training
Voordat u gezichtszoekopdrachten uitvoert, moet u een trainopdracht uitvoeren om de documentgegevenssets in uw kluis te trainen. U kunt uw kluisgegevens ook trainen via de webportal. De trainingstaak is asynchroon, trainingstijd is afhankelijk van het aantal kluisvermeldingen en installatiekopieën. Het kan enkele seconden tot een uur duren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | integer |
Inhoud van kluisvermelding ophalen
Wanneer vermeldingen worden toegevoegd aan de kluis, retourneren zowel De Core-API als de DocuPass-API een kluisvermeldings-id met de naam vaultid. U kunt de id gebruiken om een query uit te voeren op de inhoud van een vermelding in de kluis door een HTTP POST-aanvraag in te dienen bij het volgende eindpunt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
identiteitskaart
|
id | string |
Id van kluisvermelding. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | integer | |
|
identiteitskaart
|
data.id | string |
Id van kluisvermelding |
|
createtime
|
data.createtime | string |
Tijdstempel voor het maken van vermeldingen in UTC |
|
updatetime
|
data.updatetime | string |
Tijdstempel van laatste wijziging in UTC |
|
trustlevel
|
data.trustlevel | string |
Deze score wordt automatisch berekend als verificatie is ingeschakeld. (0: Onbepaald, 1: Ongeldig document, 2: Verdacht, 3: Geldig) |
|
trustnote
|
data.trustnote | string |
Waarschuwingen die zijn gekoppeld aan de geldigheid van het document. |
|
docupass_reference
|
data.docupass_reference | string |
Referentiecode voor DocuPass-sessie |
|
docupass_success
|
data.docupass_success | string |
0 of 1, of de DocuPass-verificatie is geslaagd of mislukt. |
|
docupass_failedreason
|
data.docupass_failedreason | string |
Als DocuPass-verificatie is mislukt, is de reden waarom deze is mislukt. |
|
docupass_customid
|
data.docupass_customid | string |
customid is doorgegeven bij het maken van DocuPass-verificatie. |
|
documentNumber
|
data.documentNumber | string |
De unieke id van het document (Passport No./Driver License No. etc.) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
Automatisch gegenereerde tekenreeks van documentNumber zonder symbolen, dit veld is handig voor het filteren van resultaten. |
|
personalNumber
|
data.personalNumber | string |
Een secundair id-nummer in het document |
|
voornaam
|
data.firstName | string |
Voornaam/Voornaam |
|
tweede naam
|
data.middleName | string |
Middelste naam(en) |
|
achternaam
|
data.lastName | string |
Achternaam/familienaam |
|
fullName
|
data.fullName | string |
Volledige naam (bijwerken van andere naamvelden werkt fullName niet bij) |
|
firstName_local
|
data.firstName_local | string |
Voornaam in lokale taal |
|
middleName_local
|
data.middleName_local | string |
Middelste naam in lokale taal |
|
lastName_local
|
data.lastName_local | string |
Achternaam in lokale taal |
|
fullName_local
|
data.fullName_local | string |
Volledige naam in lokale taal |
|
Dob
|
data.dob | string |
Geboortedatum |
|
Uitgegeven
|
data.issued | string |
Uitgiftedatum |
|
vervaldatum
|
data.expiry | string |
Vervaldatum |
|
geslacht
|
data.sex | string |
M: Mannelijk, F: Vrouw, X: Niet opgegeven |
|
height
|
data.height | string |
Hoogte van persoon |
|
weight
|
data.weight | string |
Gewicht van persoon |
|
hairColor
|
data.hairColor | string |
Haarkleur |
|
eyeColor
|
data.eyeColor | string |
Oogkleur |
|
adres1
|
data.address1 | string |
Adresregel 1 |
|
adres2
|
data.address2 | string |
Adresregel 2 |
|
postcode
|
data.postcode | string |
Adres postcode |
|
placeOfBirth
|
data.placeOfBirth | string |
Geboortedatum |
|
documentType
|
data.documentType | string |
P: Paspoort, D: Rijbewijs, I: Identiteitskaart, V: Visum, R: Verblijfskaart, O: Overige |
|
documentNaam
|
data.documentName | string |
Naam van document |
|
vehicleClass
|
data.vehicleClass | string |
Klasse van voertuigen op rijbewijs |
|
Beperkingen
|
data.restrictions | string |
Rijbeperkingen |
|
goedkeuring
|
data.endorsement | string |
Goedkeuring van rijbewijs |
|
e-mailadres
|
data.email | string |
E-mailadres van gebruiker |
|
mobile
|
data.mobile | string |
Mobiel telefoonnummer van gebruiker |
|
Vaste
|
data.landline | string |
Telefoonnummer voor vaste nummers van gebruiker |
|
issueAuthority
|
data.issueAuthority | string |
Instantie van document uitgeven |
|
issuerOrg_region_full
|
data.issuerOrg_region_full | string |
Subregio/status van documentverlener. Voorbeeld: Californië |
|
issuerOrg_region_abbr
|
data.issuerOrg_region_abbr | string |
Afkorting van documentverlenersubregio/staat. Voorbeeld: CA |
|
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
Document uitgegeven landcode in ISO2. Voorbeeld: VS |
|
nationality_iso2
|
data.nationality_iso2 | string |
De nationaliteit van de documenthouder in ISO2. Voorbeeld: VS |
|
optionalData
|
data.optionalData | string |
Extra niet-opgegeven gegevens in het document |
|
optionalData2
|
data.optionalData2 | string |
Extra niet-opgegeven gegevens in het document |
|
customdata1
|
data.customdata1 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan het item toe te voegen |
|
customdata2
|
data.customdata2 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan het item toe te voegen |
|
customdata3
|
data.customdata3 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan het item toe te voegen |
|
customdata4
|
data.customdata4 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan het item toe te voegen |
|
customdata5
|
data.customdata5 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan het item toe te voegen |
|
blokkeren
|
data.block | string |
Stel deze parameter in om te voorkomen dat hetzelfde document wordt verzonden naar de Core-API of DocuPass. |
|
contract
|
data.contract | string |
Koppeling naar contract- of juridische documenten die zijn gegenereerd/ondertekend met core-API of DocuPass |
|
image
|
data.image | array of object |
Bevat een lijst met afbeeldingen die zijn gekoppeld aan de vermelding. |
|
identiteitskaart
|
data.image.id | string |
Afbeeldings-id |
|
type
|
data.image.type | string |
0 voor document en 1 voor persoon |
|
hekje
|
data.image.hash | string |
MD5-hash van installatiekopieën |
|
url
|
data.image.url | string |
URL naar de afbeelding |
|
createtime
|
data.image.createtime | string |
Tijdafbeelding is geüpload in UTC |
Kern-API-instelling
Verificatie-API voor meervoudige id's om extern fysiek document te verifiëren, de authenticiteit en het gezicht komen overeen met het document met uw gebruikersfoto.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in uw webportal. |
|
file_base64
|
file_base64 | string |
U kunt een base64-gecodeerde afbeelding uploaden als een tekenreeks met behulp van application/x-www-form-urlencoded of application/json. |
|
|
url
|
url | string |
Core-API kan externe installatiekopieën van uw server downloaden. |
|
|
file_back_base64
|
file_back_base64 | string |
Met Base64 gecodeerde afbeelding van de achterkant van het document om een dubbele scan uit te voeren. |
|
|
url_back
|
url_back | string |
Externe afbeelding van de achterkant van het document om een dubbele scan uit te voeren. |
|
|
face_base64
|
face_base64 | string |
Met Base64 gecodeerde afbeelding van het gezicht van een persoon om biometrische fotoverificatie uit te voeren. |
|
|
faceurl
|
faceurl | string |
Een externe afbeelding van het gezicht van een persoon om biometrische fotoverificatie uit te voeren. |
|
|
video_base64
|
video_base64 | string |
Base64-gecodeerde selfievideo om biometrische videobeelden uit te voeren. |
|
|
videourl
|
videourl | string |
Externe gehoste selfievideo om biometrische video van video uit te voeren. |
|
|
wachtwoordcode
|
passcode | string |
Getal van 4 cijfers |
|
|
nauwkeurigheid
|
accuracy | integer |
Configureer de snelheid en nauwkeurigheid van documentherkenning en ocr-resultaten. Lage nauwkeurigheid vermindert de reactietijd tot minder dan 1 seconde, terwijl hoge nauwkeurigheid doorgaans 2~3 seconden duurt. |
|
|
authenticate
|
authenticate | boolean |
Valideer het document om te controleren of het document authentiek is en niet is geknoeid. |
|
|
authenticate_module
|
authenticate_module | string |
Geef de module op die wordt gebruikt voor het valideren van het document. |
|
|
biometric_threshold
|
biometric_threshold | float |
Geef de minimale score op om gezichtsbiometrieverificatie door te geven |
|
|
return_confidence
|
return_confidence | boolean |
Betrouwbaarheidsscore retourneren voor elk gegevensveld. |
|
|
return_empty
|
return_empty | boolean |
U kunt de API ophalen om null op lege velden te retourneren door deze parameter in te schakelen. |
|
|
ocr_scaledown
|
ocr_scaledown | integer |
Getal tussen 500 en 4000 of 0 |
|
|
outputimage
|
outputimage | boolean |
Een bijgesneden afbeelding van het document maken. |
|
|
outputface
|
outputface | boolean |
Een bijgesneden afbeelding van het gezichtsgebied in het document produceren. |
|
|
outputmode
|
outputmode | string |
Uitvoer van het bijgesneden document en gezicht als URL- of base64-gecodeerde inhoud. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Controleer of de namen, het documentnummer en het documenttype overeenkomen tussen de voor- en achterkant van het document bij het uitvoeren van dubbele scanbewerkingen. Als er informatie niet overeenkomt met fout 14, wordt fout 14 gegenereerd. |
|
|
verify_expiry
|
verify_expiry | boolean |
Controleer of het document nog geldig is op basis van de vervaldatum. |
|
|
verify_documentno
|
verify_documentno | string |
Controleer of het opgegeven documentnummer overeenkomt met het document. |
|
|
verify_dob
|
verify_dob | string |
Controleer of de opgegeven geboortedatum overeenkomt met het document. (JJJJ/MM/DD) |
|
|
verify_age
|
verify_age | string |
Controleer of de documenthouder tussen het opgegeven bereik is verouderd. (bereik, voorbeeld: 18-40) |
|
|
verify_address
|
verify_address | string |
Controleer of het opgegeven adres overeenkomt met het document. |
|
|
verify_postcode
|
verify_postcode | string |
Controleer of de opgegeven postcode overeenkomt met het document. |
|
|
country
|
country | string |
Controleer of het document is uitgegeven door de opgegeven landen, als er geen foutcode 10 wordt gegenereerd. Scheid meerdere waarden met komma's. Bijvoorbeeld 'VS,CA' accepteert documenten uit de Verenigde Staten en Canada. |
|
|
region
|
region | string |
Controleer of het document is uitgegeven met de opgegeven status, als er geen foutcode 11 wordt gegenereerd. Scheid meerdere waarden met komma's. Bijvoorbeeld 'CA', TX, accepteert documenten uit Californië en Texas. |
|
|
type
|
type | string |
Controleer of het document een van de opgegeven typen is, als er geen foutcode 12 wordt gegenereerd. Zo accepteert 'PD' zowel paspoort- als rijbewijs. |
|
|
checkblocklist
|
checkblocklist | boolean |
Controleer de documentgegevens tegen geblokkeerde vermeldingen in uw kluis. Als het document overeenkomt met een van de geblokkeerde vermeldingsfout 15 wordt gegenereerd |
|
|
vault_save
|
vault_save | boolean |
Sla de documentafbeelding en geparseerde informatie op in uw beveiligde kluis. U kunt documentvermeldingen in uw kluis weergeven, doorzoeken en bijwerken via de Vault-API of webportal. |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
Sla de documentafbeelding op in uw kluis, zelfs als het document niet kan worden herkend. |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
Voorkomen dat gedupliceerde afbeeldingen worden opgeslagen. |
|
|
vault_automerge
|
vault_automerge | boolean |
Voeg automatisch afbeeldingen met hetzelfde documentnummer samen in één vermelding in de kluis. |
|
|
vault_customdata1
|
vault_customdata1 | string |
Voeg maximaal 5 aangepaste tekenreeksen toe die worden gekoppeld aan de kluisvermelding. Dit kan handig zijn voor het filteren en doorzoeken van vermeldingen. |
|
|
vault_customdata2
|
vault_customdata2 | string |
Voeg maximaal 5 aangepaste tekenreeksen toe die worden gekoppeld aan de kluisvermelding. Dit kan handig zijn voor het filteren en doorzoeken van vermeldingen. |
|
|
vault_customdata3
|
vault_customdata3 | string |
Voeg maximaal 5 aangepaste tekenreeksen toe die worden gekoppeld aan de kluisvermelding. Dit kan handig zijn voor het filteren en doorzoeken van vermeldingen. |
|
|
vault_customdata4
|
vault_customdata4 | string |
Voeg maximaal 5 aangepaste tekenreeksen toe die worden gekoppeld aan de kluisvermelding. Dit kan handig zijn voor het filteren en doorzoeken van vermeldingen. |
|
|
vault_customdata5
|
vault_customdata5 | string |
Voeg maximaal 5 aangepaste tekenreeksen toe die worden gekoppeld aan de kluisvermelding. Dit kan handig zijn voor het filteren en doorzoeken van vermeldingen. |
|
|
aml_check
|
aml_check | boolean |
Controleer de naam en het documentnummer van de documenthouder op id Analyzer AML-database. |
|
|
aml_database
|
aml_database | string |
Scheid elke databasecode met komma, bijvoorbeeld: un_sc,us_ofac. |
|
|
aml_strict_match
|
aml_strict_match | boolean |
Schakel deze parameter in om fout-positieven te verminderen door alleen overeenkomende entiteiten met exact dezelfde nationaliteit en verjaardag te vergelijken. |
|
|
contract_generate
|
contract_generate | string |
Contractsjabloon-id voor automatisch doorvoeren met gebruikersgegevens. |
|
|
contract_format
|
contract_format | string |
Uitvoerdocumentindeling. Optioneel: PDF, DOCX, HTML. |
|
|
contract_prefill_data
|
contract_prefill_data | object |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
documentNumber
|
result.documentNumber | string |
Unieke id die is gekoppeld aan het document (bijvoorbeeld Passport No./Driver License No./Card Number etc) |
|
personalNumber
|
result.personalNumber | string |
Unieke persoonlijke id die is gekoppeld aan de persoon binnen een land (bijvoorbeeld nationaal id-nummer) |
|
voornaam
|
result.firstName | string |
Voornaam/Voornaam |
|
achternaam
|
result.lastName | string |
Achternaam/familienaam |
|
tweede naam
|
result.middleName | string |
Middelste naam(en) |
|
fullName
|
result.fullName | string |
Als de voornaam en achternaam niet kunnen worden onderscheiden, wordt in plaats daarvan volledige naam geretourneerd |
|
firstName_local
|
result.firstName_local | string |
Voornaam in lokale taal, indien beschikbaar |
|
lastName_local
|
result.lastName_local | string |
Achternaam in lokale taal, indien beschikbaar |
|
middleName_local
|
result.middleName_local | string |
Middelste naam in lokale taal, indien beschikbaar |
|
fullName_local
|
result.fullName_local | string |
Volledige naam in lokale taal, indien beschikbaar |
|
geslacht
|
result.sex | string |
Geslacht M=Mannelijke F=Vrouwelijke X=Niet opgegeven |
|
height
|
result.height | string |
Hoogte van persoon |
|
weight
|
result.weight | string |
Gewicht van persoon |
|
hairColor
|
result.hairColor | string |
Haarkleur - ANSI D-20 haarkleurcode (3 letters) |
|
eyeColor
|
result.eyeColor | string |
Oogkleur - ANSI D-20 oogkleurcode (3 letters) |
|
leeftijd
|
result.age | integer |
Leeftijd van de houder van het document |
|
Dob
|
result.dob | string |
Geboortedatum in JJJJ/MM/DD |
|
dob_day
|
result.dob_day | integer |
Geboortedatum 1 tot en met 31 |
|
dob_month
|
result.dob_month | integer |
Geboortedatum 1 tot 12 |
|
dob_year
|
result.dob_year | integer |
Geboortedatum in JJJJ |
|
vervaldatum
|
result.expiry | string |
Vervaldatum van document in JJJJ/MM/DD |
|
expiry_day
|
result.expiry_day | integer |
De vervaldatum 1 tot en met 31 |
|
expiry_month
|
result.expiry_month | integer |
Maand van vervaldatum 1 tot 12 |
|
expiry_year
|
result.expiry_year | integer |
Jaar van vervaldatum in JJJJ |
|
daysToExpiry
|
result.daysToExpiry | integer |
Aantal dagen voordat het document verloopt |
|
Uitgegeven
|
result.issued | string |
Datum van uitgifte in JJJJ/MM/DD |
|
issued_day
|
result.issued_day | integer |
Dag van uitgifte 1 tot 31 |
|
issued_month
|
result.issued_month | integer |
Maand van uitgifte 1 tot en met 12 |
|
issued_year
|
result.issued_year | integer |
Jaar van uitgifte in JJJJ |
|
daysFromIssue
|
result.daysFromIssue | integer |
Aantal dagen sinds het document is uitgegeven |
|
adres1
|
result.address1 | string |
Adresregel 1 |
|
adres2
|
result.address2 | string |
Adresregel 2 |
|
postcode
|
result.postcode | string |
Adres postcode |
|
placeOfBirth
|
result.placeOfBirth | string |
Geboortedatum |
|
vehicleClass
|
result.vehicleClass | string |
Klasse rijbewijsvoertuig |
|
Beperkingen
|
result.restrictions | string |
Beperkingen voor rijbewijs |
|
goedkeuring
|
result.endorsement | string |
Goedkeuring van rijbewijs |
|
optionalData
|
result.optionalData | string |
Extra niet-opgegeven gegevens in het document |
|
optionalData2
|
result.optionalData2 | string |
Extra niet-opgegeven gegevens in het document |
|
documentType
|
result.documentType | string |
Type of document: P=Passport, D=Driver's License, I=Identity Card, V=Visa, R=Residence Card, O=Other |
|
documentSide
|
result.documentSide | string |
Zijkant van het document: FRONT, BACK of BIODATA |
|
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
Subregio/status van documentverlener. (bijvoorbeeld Californië) |
|
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
Afkorting van documentverlenersubregio/staat. (bijvoorbeeld CA) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
Document uitgegeven land. (bijvoorbeeld Verenigde Staten) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
Document uitgegeven landcode in ISO2. (bijvoorbeeld VS) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
Document uitgegeven landcode in ISO3. (bijvoorbeeld VS) |
|
nationality_full
|
result.nationality_full | string |
De nationaliteit van de houder van het document. (bijvoorbeeld Verenigde Staten) |
|
nationality_iso2
|
result.nationality_iso2 | string |
De nationaliteit van de documenthouder in ISO2. (bijvoorbeeld VS) |
|
nationality_iso3
|
result.nationality_iso3 | string |
De nationaliteit van de documenthouder in ISO3. (bijvoorbeeld VS) |
|
internalId
|
result.internalId | string |
Wordt gebruikt om de unieke document-id onder het ID Analyzer-systeem te identificeren. Hetzelfde type document moet dezelfde id hebben. |
|
documentNumber
|
confidence.documentNumber | float |
betrouwbaarheidsniveau van documentNumber |
|
voornaam
|
confidence.firstName | float |
betrouwbaarheidsniveau van firstName |
|
achternaam
|
confidence.lastName | float |
betrouwbaarheidsniveau van achternaam /familienaam |
|
tweede naam
|
confidence.middleName | float |
betrouwbaarheidsniveau van middelste naam(en) |
|
dob_month
|
confidence.dob_month | float |
betrouwbaarheidsniveau van dob_month |
|
dob_day
|
confidence.dob_day | float |
betrouwbaarheidsniveau van dob_day |
|
dob_year
|
confidence.dob_year | float |
betrouwbaarheidsniveau van dob_year |
|
issued_month
|
confidence.issued_month | float |
betrouwbaarheidsniveau van issued_month |
|
issued_day
|
confidence.issued_day | float |
betrouwbaarheidsniveau van issued_day |
|
issued_year
|
confidence.issued_year | float |
betrouwbaarheidsniveau van issued_year |
|
expiry_month
|
confidence.expiry_month | float |
betrouwbaarheidsniveau van expiry_month |
|
expiry_day
|
confidence.expiry_day | float |
betrouwbaarheidsniveau van expiry_day |
|
expiry_year
|
confidence.expiry_year | float |
betrouwbaarheidsniveau van expiry_year |
|
geslacht
|
confidence.sex | float |
betrouwbaarheidsniveau van seks |
|
height
|
confidence.height | float |
betrouwbaarheidsniveau van hoogte |
|
weight
|
confidence.weight | float |
betrouwbaarheidsniveau van gewicht |
|
adres1
|
confidence.address1 | float |
betrouwbaarheidsniveau van adres1 |
|
adres2
|
confidence.address2 | float |
betrouwbaarheidsniveau van adres2 |
|
postcode
|
confidence.postcode | float |
betrouwbaarheidsniveau postcode |
|
vehicleClass
|
confidence.vehicleClass | float |
betrouwbaarheidsniveau van vehicleClass |
|
Beperkingen
|
confidence.restrictions | float |
betrouwbaarheidsniveau van beperkingen |
|
goedkeuring
|
confidence.endorsement | float |
betrouwbaarheidsniveau van goedkeuring |
|
eyeColor
|
confidence.eyeColor | float |
betrouwbaarheidsniveau van eyeColor |
|
leeftijd
|
confidence.age | float |
betrouwbaarheidsniveau leeftijd |
|
Dob
|
confidence.dob | float |
betrouwbaarheidsniveau van dob |
|
daysToExpiry
|
confidence.daysToExpiry | float |
betrouwbaarheidsniveau van daysToExpiry |
|
vervaldatum
|
confidence.expiry | float |
betrouwbaarheidsniveau van vervaldatum |
|
Uitgegeven
|
confidence.issued | float |
betrouwbaarheidsniveau van uitgegeven |
|
daysFromIssue
|
confidence.daysFromIssue | float |
betrouwbaarheidsniveau van daysFromIssue |
|
fullName
|
confidence.fullName | float |
betrouwbaarheidsniveau van fullName |
|
isIdentical
|
face.isIdentical | boolean |
Biometrische verificatie is geslaagd of mislukt |
|
vertrouwen
|
face.confidence | string |
Waarde tussen 0 en 1 over hoe vergelijkbaar de twee gezichten zijn, waarbij 1 identiek is. |
|
fout
|
face.error | integer |
Foutcode |
|
error_message
|
face.error_message | string |
Foutmelding. Voorbeeld: Kan gezichtsgegevens niet vinden in gezichtsafbeelding |
|
Doorgegeven
|
verification.passed | boolean |
Als het document alle verificaties heeft doorstaan, wordt waar geretourneerd. Als het document ten minste één verificatietype is mislukt, wordt onwaar geretourneerd. |
|
gezicht
|
verification.result.face | boolean |
Als biometrische verificatie is ingeschakeld, of de betrouwbaarheidsscore van overeenkomsten hoger is dan de drempelwaarde. |
|
niet verlopen
|
verification.result.notexpired | boolean |
Of het document nog niet is verlopen. |
|
naam
|
verification.result.name | boolean |
Of de opgegeven naam overeenkomt met de naam die is geparseerd op basis van id. |
|
Dob
|
verification.result.dob | boolean |
Of de opgegeven verjaardag overeenkomt met de verjaardag die is geparseerd op basis van id. |
|
documentNumber
|
verification.result.documentNumber | boolean |
Of het opgegeven documentnummer overeenkomt met het documentnummer dat is geparseerd op basis van id. |
|
postcode
|
verification.result.postcode | boolean |
Of de opgegeven postcode overeenkomt met de postcode die is geparseerd op basis van id. |
|
address
|
verification.result.address | boolean |
Of het opgegeven adres overeenkomt met het adres dat is geparseerd op basis van id. |
|
checkdigit
|
verification.result.checkdigit | boolean |
Als het type document een controlecijfer/soundex-algoritme heeft, of de controlecijfers geldig zijn. |
|
leeftijd
|
verification.result.age | boolean |
Of de documenthouder binnen het ingestelde leeftijdsbereik valt. |
|
cccode
|
verification.result.cccode | boolean |
Als het type document een Implementatie van Chinese commerciële code (CC-code) heeft, of de CC-codes geldig zijn. |
|
partituur
|
authentication.score | float |
De score is een float tussen 0 en 1. Geldige documenten hebben een score dichter bij 1, terwijl valse of bewerkte documenten een score dichter bij 0 hebben. Het is uw discretie om de grens te bepalen, een goed uitgangspunt is het weigeren van score minder dan 0,5 |
|
Doorgegeven
|
authentication.breakdown.data_visibility.passed | boolean | |
|
Doorgegeven
|
authentication.breakdown.image_quality.passed | boolean | |
|
Doorgegeven
|
authentication.breakdown.feature_referencing.passed | boolean | |
|
Doorgegeven
|
authentication.breakdown.exif_check.passed | boolean | |
|
code
|
authentication.breakdown.exif_check.code | integer | |
|
reden
|
authentication.breakdown.exif_check.reason | string | |
|
severity
|
authentication.breakdown.exif_check.severity | string | |
|
Doorgegeven
|
authentication.breakdown.publicity_check.passed | boolean | |
|
code
|
authentication.breakdown.publicity_check.code | integer | |
|
reden
|
authentication.breakdown.publicity_check.reason | string | |
|
severity
|
authentication.breakdown.publicity_check.severity | string | |
|
Doorgegeven
|
authentication.breakdown.text_analysis.passed | boolean | |
|
Doorgegeven
|
authentication.breakdown.biometric_analysis.passed | boolean | |
|
Doorgegeven
|
authentication.breakdown.security_feature_check.passed | boolean | |
|
code
|
authentication.breakdown.security_feature_check.code | integer | |
|
reden
|
authentication.breakdown.security_feature_check.reason | string | |
|
severity
|
authentication.breakdown.security_feature_check.severity | string | |
|
Doorgegeven
|
authentication.breakdown.recapture_check.passed | boolean | |
|
code
|
authentication.breakdown.recapture_check.code | integer | |
|
reden
|
authentication.breakdown.recapture_check.reason | string | |
|
severity
|
authentication.breakdown.recapture_check.severity | string | |
|
waarschuwing
|
authentication.warning | array of string |
Matrix van tekenreeks met waarschuwingsberichten over de geldigheid van het document. |
|
aml
|
aml | array of object |
Matrix met een lijst met AML-overeenkomsten retourneert een lege matrix als er geen overeenkomst is gevonden. Raadpleeg de AML API-naslaginformatie voor specifieke details. |
|
entiteit
|
aml.entity | string |
persoon of rechtspersoon |
|
fullname
|
aml.fullname | array of string |
Naam(en) van persoon of rechtspersoon |
|
voornaam
|
aml.firstname | array of string |
Voornaam(en) van persoon |
|
achternaam
|
aml.lastname | array of string |
Achternaam(en) van persoon |
|
middlename
|
aml.middlename | array of string |
Middelste naam(en) van persoon |
|
alias
|
aml.alias | array of string |
Alternatieve of refererende naam(en) van de entiteit |
|
Dob
|
aml.dob | array of string |
De verjaardag van peron kan worden geleverd in JJJJ, JJJJ-MM of JJJJ-MM-DD indelingen. |
|
address
|
aml.address | array of string |
Adres of verblijfsland van de entiteit |
|
nationaliteit
|
aml.nationality | array of string |
Land of nationaliteit van de entiteit |
|
geboorteplaats
|
aml.birthplace | array of string |
Geboorteplaats peron |
|
gender
|
aml.gender | array of string |
Geslacht peron: M of F |
|
documentnummer
|
aml.documentnumber | array of object |
Een lijst met documenten die aan de entiteit zijn gekoppeld. |
|
identiteitskaart
|
aml.documentnumber.id | string |
Documentnummer |
|
id_formatted
|
aml.documentnumber.id_formatted | string |
Alfanumeriek documentnummer |
|
country
|
aml.documentnumber.country | string |
ISO2-landcode |
|
type
|
aml.documentnumber.type | string |
P = Paspoortnummer, I = ID-nummer, D = Rijbewijsnummer, O = Ander/Onbekend documenttype |
|
programma
|
aml.program | array of string |
Sancatieprogramma('s) |
|
notitie
|
aml.note | array of string |
Aanvullende opmerking voor de entiteit |
|
time
|
aml.time | string |
UTC TZ-tijdstempel wanneer de entiteit is toegevoegd aan de bronlijst of voor het laatst is bijgewerkt |
|
status
|
aml.status | string |
Positie/titel van de entiteit of de huidige status van de sanctie |
|
source
|
aml.source | array of string |
Een lijst met officiële bron-URL('s) |
|
gegevensbank
|
aml.database | string |
Id Analyzer AML-databasecode |
|
schema
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
URL voor gegenereerd document |
|
fout
|
contract.error | string |
Als het contract niet kan worden gegenereerd, bevat dit veld de reden, zoals 'Ongeldige contractsjabloon-id'. |
|
vaultid
|
vaultid | string |
Unieke id voor de kluisvermelding als vault_save is ingeschakeld. |
|
matchrate
|
matchrate | float |
De verhouding tussen velden die door de API zijn herkend, geeft een lage verhouding aan dat de documentafbeelding te wazig is. |
|
output
|
output | string |
Als outputimage is ingesteld op true en outputmode url is, bevat dit veld een URL (of een matrix met URL's voor dualside-scan) die verwijst naar de bijgesneden documentafbeelding. De koppeling is alleen gegarandeerd gedurende 600 seconden live en wordt op elk gewenst moment daarna verwijderd. |
|
outputface
|
outputface | string |
Als outputface is ingesteld op true en outputmode url is, bevat dit veld een URL die verwijst naar de bijgesneden gezichtafbeelding. De koppeling is alleen gegarandeerd gedurende 600 seconden live en wordt op elk gewenst moment daarna verwijderd. |
|
Bijgesneden
|
cropped | string |
Als outputimage is ingesteld op true en outputmode base64 is, bevat dit veld een base64-gecodeerde afbeelding (of een matrix met base64-gecodeerde afbeeldingen voor dualside-scan) van bijgesneden documenten in JPEG-indeling |
|
bijgesneden gezicht
|
croppedface | string |
Als outputface is ingesteld op true en outputmode base64 is, bevat dit veld een base64-gecodeerde afbeelding van bijgesneden gezichtsgebied van het document in JPEG-indeling |
|
uitvoering Tijd
|
executionTime | float |
De tijd die nodig is voor de API-bewerking in seconden. |
|
responseID
|
responseID | string |
Een unieke id om de aanvraag/reactie te identificeren. |
|
quota
|
quota | integer |
Resterende API-quotum, wordt opnieuw ingesteld aan het begin van elke maand voor gratis of jaarlijkse abonnee, of aan het begin van elke factureringscyclus voor maandelijkse abonnee. Als u een abonnement hebt, wordt uw maandelijkse quotum gebruikt vóór uw tegoed. |
|
krediet
|
credit | integer |
Resterend testtegoed voor uw account. Als u een abonnement hebt, wordt uw maandelijkse quotum gebruikt vóór uw tegoed. |
Kluisvermelding bijwerken
U kunt de waarde van één veld of waarden van meerdere velden in een kluisvermelding bijwerken door een HTTP POST-aanvraag te maken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
identiteitskaart
|
id | True | string |
Id van kluisvermelding. |
|
adres1
|
address1 | string |
Adresregel 1. |
|
|
adres2
|
address2 | string |
Adresregel 2. |
|
|
blokkeren
|
block | string |
Stel deze parameter in om te voorkomen dat hetzelfde document wordt verzonden naar de Core-API of DocuPass. 0: Geen blok 1: Documentnummer 2 blokkeren: Voornaam/achternaam 3 blokkeren: Zowel documentnummer als voornaam/achternaam blokkeren. |
|
|
customdata1
|
customdata1 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan de vermelding toe te voegen. |
|
|
customdata2
|
customdata2 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan de vermelding toe te voegen. |
|
|
customdata3
|
customdata3 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan de vermelding toe te voegen. |
|
|
customdata4
|
customdata4 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan de vermelding toe te voegen. |
|
|
customdata5
|
customdata5 | string |
5 aangepaste tekenreeksen die kunnen worden gebruikt om aangepaste memo aan de vermelding toe te voegen. |
|
|
Dob
|
dob | string |
Geboortedatum (JJJJ-MM-DD). |
|
|
documentNaam
|
documentName | string |
Naam van document. |
|
|
documentNumber
|
documentNumber | string |
De unieke id van het document (Passport No./Driver License No. etc.) |
|
|
documentType
|
documentType | string |
P: Paspoort D: Rijbewijs I: Identiteitskaart V: Visa R: Residence Card O: Overige |
|
|
docupass_customid
|
docupass_customid | string |
customid is doorgegeven bij het maken van DocuPass-verificatie. |
|
|
docupass_failedreason
|
docupass_failedreason | string |
Als DocuPass-verificatie is mislukt, is de reden waarom deze is mislukt. |
|
|
docupass_reference
|
docupass_reference | string |
Referentiecode voor DocuPass-sessie. |
|
|
docupass_success
|
docupass_success | string |
0 of 1, of de DocuPass-verificatie is geslaagd of mislukt. |
|
|
e-mailadres
|
string |
E-mailadres van gebruiker. |
||
|
vervaldatum
|
expiry | string |
Vervaldatum (JJJJ-MM-DD) |
|
|
eyeColor
|
eyeColor | string |
Oogkleur. |
|
|
voornaam
|
firstName | string |
Voornaam/Voornaam |
|
|
firstName_local
|
firstName_local | string |
Voornaam in de lokale taal. |
|
|
fullName
|
fullName | string |
Volledige naam (bijwerken van andere naamvelden werkt fullName niet bij) |
|
|
fullName_local
|
fullName_local | string |
Voornaam in de lokale taal. |
|
|
hairColor
|
hairColor | string |
Haarkleur. |
|
|
height
|
height | string |
Hoogte van persoon. |
|
|
issueAuthority
|
issueAuthority | string |
Instantie van document uitgeven. |
|
|
Uitgegeven
|
issued | string |
Uitgiftedatum (JJJJ-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
Document uitgegeven landcode in ISO2. Voorbeeld: VS |
|
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
Afkorting van documentverlenersubregio/staat. Voorbeeld: CA |
|
|
issuerOrg_region_full
|
issuerOrg_region_full | string |
Subregio/status van documentverlener. Voorbeeld: Californië |
|
|
Vaste
|
landline | string |
Telefoonnummer voor vaste nummers van gebruiker. |
|
|
achternaam
|
lastName | string |
Achternaam/familienaam. |
|
|
lastName_local
|
lastName_local | string |
Achternaam in de lokale taal. |
|
|
tweede naam
|
middleName | string |
Middelste naam(en). |
|
|
middleName_local
|
middleName_local | string |
Middelste naam in de lokale taal. |
|
|
mobile
|
mobile | string |
Mobiele telefoonnummer van de gebruiker. |
|
|
nationality_iso2
|
nationality_iso2 | string |
De nationaliteit van de documenthouder in ISO2. Voorbeeld: VS |
|
|
optionalData
|
optionalData | string |
Extra niet-opgegeven gegevens in het document. |
|
|
optionalData2
|
optionalData2 | string |
Extra niet-opgegeven gegevens in het document. |
|
|
personalNumber
|
personalNumber | string |
Een secundair id-nummer in het document. |
|
|
placeOfBirth
|
placeOfBirth | string |
Geboortedatum. |
|
|
postcode
|
postcode | string |
Adres postcode. |
|
|
Beperkingen
|
restrictions | string |
Rijbeperkingen. |
|
|
geslacht
|
sex | string |
M: Mannelijke F: Vrouwelijke X: Niet opgegeven |
|
|
trustlevel
|
trustlevel | string |
0: Onbepaald 1: Ongeldig document 2: Verdacht 3: Geldig deze score wordt automatisch berekend als verificatie is ingeschakeld. |
|
|
trustnote
|
trustnote | string | ||
|
vehicleClass
|
vehicleClass | string |
Klasse voertuigen op rijbewijs. |
|
|
weight
|
weight | string |
Gewicht van persoon. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | integer |
Lijst- en filtervermeldingen
Als u alle vermeldingen wilt weergeven die zijn opgeslagen in de kluis of zoekt naar vermeldingen met specifieke waarden, verzendt u een HTTP POST-aanvraag naar het volgende eindpunt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
orderby
|
orderby | string |
De naam van het veld dat wordt gebruikt om het resultaat te orden. |
|
|
sort
|
sort | string |
ASC voor het sorteren van resultaten in oplopende volgorde, DESC om in aflopende volgorde te sorteren. |
|
|
limit
|
limit | integer |
Aantal te retourneren kluisvermeldingen. (1 tot 100) |
|
|
offset
|
offset | integer |
Retourlijst beginnend bij een specifieke vermelding, bijvoorbeeld wanneer limit=10, toegang wilt krijgen tot de derde pagina van de resultaten, gebruikt u offset=20 |
|
|
filter
|
filter | array of string |
filter |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
limit
|
limit | integer |
Huidige limiet |
|
offset
|
offset | integer |
Huidige verschuiving |
|
nextoffset
|
nextoffset | integer |
Verschuivingswaarde voor de volgende set gegevens. Als de huidige set gegevens de laatste set gegevens is, wordt dit veld niet geretourneerd. |
|
totaal
|
total | integer |
Totaal aantal gevonden vermeldingen. |
|
items
|
items | array of |
Een matrix met gevonden items en de volledige inhoud ervan, identiek aan de inhoud die wordt geretourneerd door de GET-methode. |
Trainingsstatus
Controleer of de kluistraining nog steeds actief is of is voltooid.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
status
|
status | string |
niet getraind: Nooit getraind, niet gestart: Training wordt niet uitgevoerd, wordt uitgevoerd: Training wordt momenteel uitgevoerd, geslaagd: Training geslaagd, mislukt: Training is mislukt |
|
startTime
|
startTime | string |
Tijdstip waarop de laatste training is gestart in UTC. |
|
statusChangeTime
|
statusChangeTime | string |
Tijd voor laatste statuswijziging in UTC. |
|
lastSuccessTime
|
lastSuccessTime | string |
Tijd voor de laatste geslaagde training in UTC. |
|
fout
|
error | string |
Foutbericht dat is gekoppeld aan de mislukte trainingsstatus. |
Vermelding uit kluis verwijderen
U kunt enkele of meerdere kluisvermeldingen verwijderen door een HTTP POST-aanvraag te maken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
identiteitskaart
|
id | True | array of string |
identiteitskaart |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
succes
|
success | integer |
Zoeken in AML-database
Met de AML-API kunt u de globale AML-database van ID Analyzer doorzoeken op sancties, PSP's en gewilde criminelen met behulp van een naam, documentnummer of beide. U kunt de resultaten verder filteren met verjaardag en nationaliteit.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in uw webportal. |
|
naam
|
name | string |
De naam of alias van de persoon of organisatie in elke taal. |
|
|
documentnummer
|
documentnumber | string |
Het paspoortnummer van de persoon, het nationale id-nummer of het rijbewijsnummer, enz. |
|
|
entiteit
|
entity | string |
persoon: Persoon; legalentiteit: Bedrijf of Organisatie |
|
|
country
|
country | string |
Alleen entiteiten met overeenkomende land/nationaliteit of geen landgegevens retourneren. |
|
|
Dob
|
dob | string |
Retourneer alleen entiteiten met overeenkomende verjaardags- of geen verjaardagsgegevens. |
|
|
gegevensbank
|
database | string |
Geef de brondatabases op om de AML-controle uit te voeren, indien leeg, worden alle brondatabases gecontroleerd. Scheid elke databasecode met komma, bijvoorbeeld: un_sc,us_ofac. Ga naar AML API Overview voor een volledige lijst met brondatabases en bijbehorende code. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
aml
|
items | array of object |
Matrix met een lijst met AML-overeenkomsten retourneert een lege matrix als er geen overeenkomst is gevonden. Raadpleeg de AML API-naslaginformatie voor specifieke details. |
|
entiteit
|
items.entity | string |
persoon of rechtspersoon |
|
fullname
|
items.fullname | array of string |
Naam(en) van persoon of rechtspersoon |
|
voornaam
|
items.firstname | array of string |
Voornaam(en) van persoon |
|
achternaam
|
items.lastname | array of string |
Achternaam(en) van persoon |
|
middlename
|
items.middlename | array of string |
Middelste naam(en) van persoon |
|
alias
|
items.alias | array of string |
Alternatieve of refererende naam(en) van de entiteit |
|
Dob
|
items.dob | array of string |
De verjaardag van peron kan worden geleverd in JJJJ, JJJJ-MM of JJJJ-MM-DD indelingen. |
|
address
|
items.address | array of string |
Adres of verblijfsland van de entiteit |
|
nationaliteit
|
items.nationality | array of string |
Land of nationaliteit van de entiteit |
|
geboorteplaats
|
items.birthplace | array of string |
Geboorteplaats peron |
|
gender
|
items.gender | array of string |
Geslacht peron: M of F |
|
documentnummer
|
items.documentnumber | array of object |
Een lijst met documenten die aan de entiteit zijn gekoppeld. |
|
identiteitskaart
|
items.documentnumber.id | string |
Documentnummer |
|
id_formatted
|
items.documentnumber.id_formatted | string |
Alfanumeriek documentnummer |
|
country
|
items.documentnumber.country | string |
ISO2-landcode |
|
type
|
items.documentnumber.type | string |
P = Paspoortnummer, I = ID-nummer, D = Rijbewijsnummer, O = Ander/Onbekend documenttype |
|
programma
|
items.program | array of string |
Sancatieprogramma('s) |
|
notitie
|
items.note | array of string |
Aanvullende opmerking voor de entiteit |
|
time
|
items.time | string |
UTC TZ-tijdstempel wanneer de entiteit is toegevoegd aan de bronlijst of voor het laatst is bijgewerkt |
|
status
|
items.status | string |
Positie/titel van de entiteit of de huidige status van de sanctie |
|
source
|
items.source | array of string |
Een lijst met officiële bron-URL('s) |
|
gegevensbank
|
items.database | string |
Id Analyzer AML-databasecode |
|
schema
|
items.schema | string |
Zoeken naar gezichten
Met Face Search kunt u de hele kluis doorzoeken met behulp van een afbeelding van een persoon. Als u de functie voor gezichtszoekopdrachten wilt gebruiken, moet u indexering voor facezoekopdrachten inschakelen via de webportal en uw kluisgegevenssets periodiek trainen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Uw persoonlijke API-sleutel is beschikbaar in de webportal. |
|
image
|
image | string |
Met Base64 gecodeerde afbeeldingsgegevens. |
|
|
imageurl
|
imageurl | string |
URL voor externe installatiekopieën. |
|
|
maxentry
|
maxentry | integer |
Aantal overeenkomende vermeldingen dat moet worden geretourneerd, tussen 1 en 10. |
|
|
threshold
|
threshold | float |
Stel de minimale score voor gezichtsovereenkomst in die is vereist, in het bereik van 0 tot 1. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of |
Als overeenkomende vermeldingen worden gevonden, wordt een lijst met documenten met volledige inhoud geretourneerd die vergelijkbaar zijn met de lijstopdracht. |