Rechercher par critères qualifiés

GET

/relation-tiers/v1/actors:search

const url = 'https://example.com/relation-tiers/v1/actors:search?actorNature=LEGAL_ENTITY';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/relation-tiers/v1/actors:search?actorNature=LEGAL_ENTITY' \
  --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)

cursor

string

limit

integer

<= 200

identifierType

string

identifierValue

string

actorNature

string

Allowed values: LEGAL_ENTITY NATURAL_PERSON COLLECTIVE TECHNICAL_PARTY

status

string

label

string

Réponses

200

La page de candidats filtrés.

application/json

object

items

required

Array<object>

object

actorId

required

string

identityMode

required

string

Allowed values: REFERENCE_DOMAINE IDENTITE_LOCALE

actorNature

required

string

Allowed values: LEGAL_ENTITY NATURAL_PERSON COLLECTIVE TECHNICAL_PARTY

ownerReference

object

domain

required

string

objectType

required

string

objectId

required

string

displayLabel

string

status

required

string

aggregateVersion

required

integer

redirectedTo

L’ancre canonique si une redirection logique est active.

string

nextCursor

string

Example

{
  "items": [
    {
      "identityMode": "REFERENCE_DOMAINE",
      "actorNature": "LEGAL_ENTITY"
    }
  ]
}

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).