Skip to main content
Know Your Customer

Read KYC extension

GET/v4/config/platform/extension/kyc

Reads the configuration of the Know-Your-Customer (KYC) extension: the presentation definition that it uses and the identity credentials that a wallet can present.

Send verification requests with presentationDefinitionId (OpenID4VC API, verifier). The request asks for the identity claims of the enabled credentials. For the PID, it asks for the eight mandatory attributes of the PID Rulebook: family_name, given_name, birthdate, place_of_birth, nationalities, issuing_authority, issuing_country and picture. A wallet presents one of the enabled credentials.

The answer is 404 when the extension is not enabled, also while it waits for its signing key (awaitingKey). Turn it on first with PUT /v4/config/platform/extension/kyc and a signingKeyId.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:extensions:read

Response

application/json

The configuration of the extension.

  • extensionStatusboolean

    Always true in this answer. An extension that is not enabled gives 404.

  • presentationDefinitionIdstring<uuid>

    The system-managed presentation definition of the extension. Send verification requests with it.

  • labelstring

    The label of the presentation definition.

  • identityCredentialsobject[]

    The identity credentials that the presentation definition accepts. A new KYC extension accepts the PID only.