Read KYC extension
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
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
extensions:read
Response
The configuration of the extension.
extensionStatus booleanAlways
truein this answer. An extension that is notenabledgives404.presentationDefinition Id string<uuid>The system-managed presentation definition of the extension. Send verification requests with it.
labelstringThe label of the presentation definition.
identityCredentials object[]The identity credentials that the presentation definition accepts. A new KYC extension accepts the PID only.