Defines search input for a person and returns a session ID based on which results can be requested
Email address of the data subject, used to request the required consents.
Query parameters defining the countries and data packages to retrieve. At least one entry is required.
Free-text reference supplied by the API consumer to correlate the session with an external system (e.g. subject name, contract number, internal identifier).
Optional webhook subscription to register for this session. The endpoint receives CloudEvents-formatted notifications for the selected event types, signed with the organization's webhook signing secret in accordance with the Standard Webhooks specification. Additional subscriptions can be managed through the webhook-subscriptions endpoints.
- Mock serverhttps://doc.mifundo.com/_mock/mca/v1/sessions
- Production APIhttps://api.mifundo.com/mca/v1/sessions
- Test APIhttps://apitest.mifundo.com/mca/v1/sessions
curl -i -X POST \
https://doc.mifundo.com/_mock/mca/v1/sessions \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"subjectEmail": "john.doe@example.com",
"queryParameters": [
{
"countryCode": "GBR",
"dataPackages": [
"SCORE",
"IDENTIFICATION"
]
}
],
"externalReference": null,
"webhookSubscription": null
}'Created
Unique identifier of the session. Used in subsequent requests to retrieve session-related data.
Email address of the data subject, used to request the required consents.
Full name of the data subject. Empty until the data subject has completed the identification step.
Deadline (UTC) by which the data subject must provide the required input. If the deadline passes without input, a new session must be created.
Current progress status of the data subject's input.
| Enum Value | Description |
|---|---|
| DELIVERY_FAILED | Delivery to the customer failed. |
| WAITING_FOR_CUSTOMER | Awaiting action or input from the customer. |
| COMPLETED_BY_CUSTOMER | Customer has completed the required steps. |
| EXPIRED | The customer's opportunity or session expired. |
Data packages requested for the session.
Latest point in time (UTC) up to which the customer input deadline may be extended.
Latest point in time (UTC) up to which the data packages may be upgraded.
Timestamp (UTC) at which all currently applicable customer input requirements were fulfilled, taken from the most recently satisfied requirement. Null while any requirement remains outstanding; may revert to null if new requirements are introduced.
{ "id": "8eaa67a3-33bd-4306-b4c3-e791f99b8c50", "createdAtUtc": "2025-03-12T00:00:00+00:00", "createdByName": "Wilford Lowery", "organizationalUnitName": null, "subjectEmail": "john.doe@example.com", "subjectFullName": "John Doe", "customerInputDeadlineUtc": "2027-03-26T00:00:00+00:00", "customerProgressStatus": "WAITING_FOR_CUSTOMER", "queryParameters": [ { … } ], "customerInputDeadlineExtendableUntilUtc": null, "dataPackageUpgradableUntilUtc": null, "customerInputCompletedAtUtc": null, "externalReference": "CR-1234-567890/VIP" }