Chercher le contact adapté au contexte

GET

/relation-tiers/v1/contacts:resolve

curl --request GET \
  --url 'https://example.com/relation-tiers/v1/contacts:resolve?actorId=example&purpose=example' \
  --header 'Authorization: Bearer <token>'

Autorisations

• authentification
  relation-tiers:consultation

Paramètres

Paramètres (header)

X-Tenant-Id

string

Facultatif — le tenant fait foi dans le jeton ; s’il est fourni, il doit être identique, et le corps ne peut jamais le choisir.

X-Correlation-Id

string

Paramètres (query)

effectiveAt

string format: date-time

La date d’effet de la lecture — la situation applicable à cette date ; absente, la lecture porte sur maintenant.

actorId

required

string

purpose

required

string

channelType

string

Réponses

200

Les contacts adaptés, valeur masquée — le masque non réversible et l’état de vérification, jamais la valeur.

Media typeapplication/json

object

items

required

Array<object>

object

contactPointId

required

string

channelType

required

string

maskedValue

required

string

verificationLevel

string

authorizedPurposes

Array<string>

Example^generated

{
  "items": [
    {
      "contactPointId": "example",
      "channelType": "example",
      "maskedValue": "example",
      "verificationLevel": "example",
      "authorizedPurposes": [
        "example"
      ]
    }
  ]
}

401

Aucune identité présentée (401).

403

L’identité présentée n’a pas la famille d’accès requise (403). Les 403 croisés entre familles sont prouvés par les tests d’assemblage. Un écart de tenant ne produit jamais ce code sur une ressource — il produit 404 (ne rien révéler).

404

Ressource absente ou invisible — y compris une ressource d’un autre tenant : le régime de la muraille ne révèle pas l’existence (404, jamais 403).

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details) — le texte n’expose ni l’existence d’un objet d’un autre tenant, ni une donnée sensible.

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

correlationId

required

string

retryable

boolean

violations

Array<object>

object

field

string

reason

string

ruleId

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "correlationId": "example",
  "retryable": true,
  "violations": [
    {
      "field": "example",
      "reason": "example",
      "ruleId": "example"
    }
  ]
}