Skip to main content
API docs by Redocly

Analysis API (v1)

Download OpenAPI specification:Download

URL: https://api.enablenow.nl

AnalysisJobs

Retrieve information about analysis job(s).

Authorizations:
bearer
query Parameters
(AnalysisJobStatus (string or null))

The status of the analysis jobs to retrieve.

(AnalysisEngine (string or null))

The analysis engine used to generate the analysis jobs.

ToDate
string or null <date-time>

The limit date to retrieve the analysis jobs.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new analysis job to the queue.

Authorizations:
bearer
Request Body schema: application/json
required

The command parameters

reference
string

A reference of the analysis job from the customer's perspective. Can be e.g. an external client number, or a name, or an email address. Different analysis jobs can have the same reference to allow grouping in the Navigator e.g. same analysis every month.

engine
string

The version of the engine to use to generate the analysis (default is 'z2').

profile
string

The profile to use to generate the analysis (default is 'retail').

AnalysisJobInput (object)

A group of IDs to run the analysis on: consent IDs, user IDs, previous analysis job IDs or account IDs.

object or null

An optional field to provide extra information to the analysis job, e.g. "kvk_number": "12345678".

dateFrom
string or null <date-time>

Analyze all transactions from this date.

dateTo
string or null <date-time>

Analyze all transactions until this date.

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "engine": "string",
  • "profile": "string",
  • "input": {
    },
  • "metaData": {
    },
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "accountIds": [
    ],
  • "appId": 0,
  • "engine": "Z2",
  • "status": "PENDING",
  • "profile": "RETAIL",
  • "input": null,
  • "metadata": {
    },
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "analysis": null
}

Retrieve information about a specific analysis job.

Authorizations:
bearer
path Parameters
id
required
string <guid>

Id of the analysis job

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "accountIds": [
    ],
  • "appId": 0,
  • "engine": "Z2",
  • "status": "PENDING",
  • "profile": "RETAIL",
  • "input": null,
  • "metadata": {
    },
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "analysis": null
}

Update an existing analysis job.

Currently only the Reference property can be updated.

Authorizations:
bearer
path Parameters
id
required
string <guid>

Id of the analysis job to update

Request Body schema: application/json
required

The command parameters

reference
string or null

A unique reference of this analysis job from the customer's perspective. Can be e.g. an external client number, or a name, or an email address. This value has to be unique per customer.

Responses

Request samples

Content type
application/json
{
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "accountIds": [
    ],
  • "appId": 0,
  • "engine": "Z2",
  • "status": "PENDING",
  • "profile": "RETAIL",
  • "input": null,
  • "metadata": {
    },
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "analysis": null
}

Delete the analysis job with the given id.

Only deletes the analysis job if it is not in execution.

Authorizations:
bearer
path Parameters
id
required
string <guid>

Id of the analysis job

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "traceId": "string",
  • "detail": "string",
  • "errors": {
    }
}