Ontwikkelaars

PUT/tcr/v2/brand/{brandId}/externalVetting

Een bestaand screeningsresultaat importeren

Koppel een bestaand resultaat van een ondersteunde aanbieder aan uw merk.

Op deze pagina
  1. Gebruik een berichtenmerk dat bij uw account hoort
  2. Gebruik een bestaand resultaat van een aanbieder
  3. Bereid de import voor
  4. Importeer het resultaat eenmaal
  5. Houd rekening met bestaande kosten
  6. Volg de daadwerkelijke uitkomst
  7. Herhaal hetzelfde verzoek voor dezelfde beoogde bewerking

Gebruik een berichtenmerk dat bij uw account hoort

Gebruik een ingeschakeld API-account via HTTPS vanaf een toegestaan bron-IP-adres. Authenticatie met Basic en Bearer wordt ondersteund. De merk-ID moet bij dat account horen. Houd tokens van de aanbieder, identiteitsgegevens van het merk en ontvangen rapporten vertrouwelijk.

Gebruik een bestaand resultaat van een aanbieder

Gebruik PUT om een bestaand screeningsresultaat van een ondersteunde aanbieder aan uw merk te koppelen. Hiermee bestelt u geen nieuwe screening. Vraag de juiste transactie-ID van de aanbieder en een eventueel bevestigingstoken rechtstreeks bij die aanbieder op en controleer of het rapport betrekking heeft op dezelfde bedrijfsidentiteit.

AUTHPLUS ondersteunt deze importprocedure niet. De regels van de aanbieder voor het vaststellen van een overeenkomst blijven van toepassing; een importverzoek heft deze regels niet op en garandeert niet dat u voor elk toepassingsscenario van een campagne in aanmerking komt.

Bereid de import voor

Velden voor het importeren van externe screeningsresultaten
VeldWaarde
evpIdID van een ondersteunde aanbieder, 1–10 tekens.
vettingIdDe daadwerkelijke transactie-ID van de screening bij de aanbieder, maximaal 255 tekens. Gebruik hiervoor niet de merk-ID en verzin geen ID.
vettingTokenBevestigingstoken als de aanbieder dit vereist, maximaal 65535 tekens. Behandel het als een geheim en laat het weg als de aanbieder het niet vereist.

Maak vetting-import.json aan met de daadwerkelijke waarden van de aanbieder. Verstuur geen velden voor de score, status of tijdstempel die uitsluitend in het antwoord thuishoren, alsof die het resultaat zouden kunnen wijzigen.

Importeer het resultaat eenmaal

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @vetting-import.json \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting"

Houd rekening met bestaande kosten

Deze proxy registreert een nieuw geïmporteerd resultaat niet als een nieuwe betaalde bestelling. Dit annuleert geen eerder bestelde screening: als er voor dezelfde vettingId al een bestelling bestaat die op een resultaat of afschrijving wacht, kan het importeren van een resultaat met ACTIVE of FAILED ertoe leiden dat het voor die bestelling vastgelegde bedrag wordt afgerekend. In deze tak van de synchronisatie worden voor een record waarvoor al kosten in rekening zijn gebracht niet opnieuw kosten in rekening gebracht.

Volg de daadwerkelijke uitkomst

Een geslaagd HTTP-antwoord kan een screeningsrecord bevatten waarvan het resultaat nog in behandeling is. Bewaar de vettingId en controleer vettingStatus, redenen, score en ingangs- en vervaldatums voor zover beschikbaar. PENDING en UNSCORE vereisen verdere opvolging; ACTIVE, FAILED en EXPIRED geven verschillende uitkomsten aan. Acceptatie op HTTP-niveau alleen bewijst niet dat de score gunstig is of dat u voor een campagne in aanmerking komt.

Gebruik de status van de externe screening om het record te volgen. Het uitlezen of importeren van een definitief resultaat kan leiden tot de afrekening van een eerdere betaalde bestelling; daarbij kan dus nog een bestaand openstaand bedrag in rekening worden gebracht.

Herhaal hetzelfde verzoek voor dezelfde beoogde bewerking

Gebruik één Idempotency-Key per beoogde bewerking en behoud exact dezelfde methode, hetzelfde pad, dezelfde query en dezelfde bytes van de verzoekinhoud. Sleutels mogen 1–128 afdrukbare ASCII-tekens zonder spaties bevatten. Een duplicaat van een verzoek dat nog wordt verwerkt, kan 409 met Retry-After opleveren. Voor voltooide verzoeken wordt het opgeslagen antwoord opnieuw teruggegeven, inclusief fouten. Houd u aan de limieten voor de verzoekfrequentie.

Na een transportfout kan een gecachet antwoord met 502 volgen. Een gecachet antwoord met 500 en requestId kan betekenen dat het register de bewerking heeft geaccepteerd, maar dat het lokaal opslaan van gegevens of de facturering is mislukt. Bewaar de verzoek-ID, controleer de huidige records en stem de situatie af met de ondersteuning voordat u een nieuwe sleutel gebruikt. Ga er niet van uit dat de fout betekent dat er geen bestelling bestaat.