Skip to main content

Categorization API (v1)

Download OpenAPI specification:Download

CategorizationJobs

Retrieve categorization job information

Authorizations:
bearer
query Parameters
ConsentId
string or null

The consent ID for which to retrieve transactions

UserId
string or null

The User ID for which to retrieve transactions

ExternalUserId
string or null

The External User ID for which to retrieve transactions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new categorization job to the queue

Authorizations:
bearer
query Parameters
ConsentId
string or null

The consent ID for which to create the Categorization Job

UserId
string or null

The User ID for which to create the Categorization Job

ExternalUserId
string or null

The External User ID for which to create the Categorization Job

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentId": "string",
  • "status": "string",
  • "engineVersion": "string",
  • "consentId": "string",
  • "userId": "string",
  • "externalUserId": "string"
}

Retrieve categorization job information

Authorizations:
bearer
path Parameters
Id
required
string

The job ID for which to retrieve sequencing results

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentId": "string",
  • "status": "string",
  • "engineVersion": "string",
  • "consentId": "string",
  • "userId": "string",
  • "externalUserId": "string"
}