APIInvokerEnrolmentDetails

APIInvokerEnrolmentDetails
APIInvokerEnrolmentDetails

Represents information about the API Invoker that requested to onboard.

JSON Example
{
    "apiInvokerId": "API_INVOKER_12345",
    "onboardingInformation": {
        "apiInvokerPublicKey": "PUBLIC_KEY_STRING",
        "apiInvokerCertificate": "CERTIFICATE_STRING",
        "onboardingSecret": "SECRET_STRING"
    },
    "notificationDestination": "string",
    "requestTestNotification": true,
    "apiInvokerInformation": "Generic details about API invoker"
}
string
apiInvokerId
Optional

API invoker ID assigned by the CAPIF core function to the API invoker. Must not be present in a request body.

onboardingInformation
Required

onboardingInformation

string
notificationDestination
Required

The target URI for notifications.

boolean
requestTestNotification
Optional

Request for CAPIF core function to send a test notification.

string
apiInvokerInformation
Optional

Generic information related to the API invoker.