Updates an existing session

Sessions
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Session is a collection of inputs for retrieving various sets of information

Operations

Creates a new session

Request

Defines search input for a person and returns a session ID based on which results can be requested

Security

keycloakAuthTest or keycloakAuthLive

Bodyapplication/json

subjectEmailstring or nullrequired

Data Subject email. This is used to contact the Data Subject for getting Consents.

queryParametersArray of objects or null(QueryParameter)

A collection of query parameters. At least one query parameter is required.

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"
        ]
      }
    ]
  }'

Responses

Created

Bodyapplication/json

idstring(uuid)required

Unique Session identifier. Used in subsequent requests to fetch Session related data.

createdAtUtcstring(date-time)required

Session creation time in UTC.

createdByNamestring or null

Agent name who created the Session.

organizationalUnitNamestring or null

Organizational unit name of the agent who created the Session.

subjectEmailstring or nullrequired

Data Subject email. This is used to contact the Data Subject for getting Consents

subjectFullNamestring or null

Data Subject full name. Field will stay empty until subject has completed the identification step.

customerInputDeadlineUtcstring or null(date-time)

Deadline by which the customer is expected to provide input. If Data Subject hasn't provided the input by that time, new Session should be created.

customerProgressStatusstringrequired

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.

queryParametersArray of objects or null(QueryParameter)required

Session input elements

queryParameters[].countryCodestring or nullrequired

ISO 3166-1 alpha-3 code representing the country for which the customer is requesting information about the Data Subject.

queryParameters[].dataPackagesArray of strings or null(DataPackage)

List of data packages requested for the specified country.

Enum Value	Description
CREDIT_HISTORY	Historical credit data about the customer.
SCORE	Credit score calculated based on customer data.
BANK_ACCOUNT_CATEGORIZATION	Categorization of transactions in the customer's bank account.
IDENTIFICATION	Identification documents or data of the customer.

Response

application/json

{
  "id": "889c9f82-99a8-4936-a26b-c731797a7d87",
  "createdAtUtc": "2025-03-12T00:00:00+00:00",
  "createdByName": "Wilford Lowery",
  "organizationalUnitName": null,
  "subjectEmail": "john.doe@example.com",
  "subjectFullName": "John Doe",
  "customerInputDeadlineUtc": "2025-03-26T00:00:00+00:00",
  "customerProgressStatus": "WAITING_FOR_CUSTOMER",
  "queryParameters": [
    { … }
  ]
}

Search for existing sessions

Request

Gets all sessions optionally filtered by request parameters

Security

keycloakAuthTest or keycloakAuthLive

Query

SubjectEmailstring

Email address of the data subject used to filter sessions.

SubjectFullNamestring

Full name of the data subject used to filter sessions.

CountryCodestring

ISO 3166-1 alpha-3 code representing the country related to the sessions.

CreatedFromUtcstring(date)

Start date (UTC) for filtering sessions by creation date.

CreatedToUtcstring(date)

End date (UTC) for filtering sessions by creation date.

CustomerProgressStatusstring

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.

CreatedByNamestring

Name of the person who created the session.

OrganizationalUnitNamestring

Name of the organizational unit responsible for the session.

Skipinteger(int32)

Number of records to skip when retrieving paginated results.

Takeinteger(int32)

Number of records to retrieve in the paginated result.

curl -i -X GET \
  'https://doc.mifundo.com/_mock/mca/v1/sessions?SubjectEmail=string&SubjectFullName=string&CountryCode=string&CreatedFromUtc=2019-08-24&CreatedToUtc=2019-08-24&CustomerProgressStatus=DELIVERY_FAILED&CreatedByName=string&OrganizationalUnitName=string&Skip=0&Take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

sessionsArray of objects or null(SessionItem)

List of sessions matching the query parameters.

pagingobject or null

Response

application/json

{
  "sessions": [
    { … }
  ],
  "paging": {
    "totalCount": 0,
    "skip": 0,
    "take": 0
  }
}

Get session by ID

Request

Gets a session by ID

Security

keycloakAuthTest or keycloakAuthLive

Path

sessionIdstring(uuid)required

curl -i -X GET \
  'https://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

idstring(uuid)required

Unique Session identifier. Used in subsequent requests to fetch Session related data.

createdAtUtcstring(date-time)required

Session creation time in UTC.

createdByNamestring or null

Agent name who created the Session.

organizationalUnitNamestring or null

Organizational unit name of the agent who created the Session.

subjectEmailstring or nullrequired

Data Subject email. This is used to contact the Data Subject for getting Consents

subjectFullNamestring or null

Data Subject full name. Field will stay empty until subject has completed the identification step.

customerInputDeadlineUtcstring or null(date-time)

Deadline by which the customer is expected to provide input. If Data Subject hasn't provided the input by that time, new Session should be created.

customerProgressStatusstringrequired

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.

queryParametersArray of objects or null(QueryParameter)required

Session input elements

queryParameters[].countryCodestring or nullrequired

ISO 3166-1 alpha-3 code representing the country for which the customer is requesting information about the Data Subject.

queryParameters[].dataPackagesArray of strings or null(DataPackage)

List of data packages requested for the specified country.

Enum Value	Description
CREDIT_HISTORY	Historical credit data about the customer.
SCORE	Credit score calculated based on customer data.
BANK_ACCOUNT_CATEGORIZATION	Categorization of transactions in the customer's bank account.
IDENTIFICATION	Identification documents or data of the customer.

Response

application/json

{
  "id": "77eba4c4-ae2b-46d8-b2b7-37bb85c3c42a",
  "createdAtUtc": "2025-03-12T00:00:00+00:00",
  "createdByName": "Wilford Lowery",
  "organizationalUnitName": null,
  "subjectEmail": "john.doe@example.com",
  "subjectFullName": "John Doe",
  "customerInputDeadlineUtc": "2025-03-26T00:00:00+00:00",
  "customerProgressStatus": "WAITING_FOR_CUSTOMER",
  "queryParameters": [
    { … }
  ]
}