List Extract PII jobs

curl --request GET \
  --url https://api.uat.frankie.one/v2/report/extractPII \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'X-Frankie-RequestID: <x-frankie-requestid>' \
  --header 'api_key: <api-key>'

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "jobs": [
    {
      "jobId": "<string>",
      "status": "CREATED",
      "operationType": "REPORT",
      "operationName": "EXTRACT_PII",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "attemptedAt": "2023-11-07T05:31:56Z",
      "finalizedAt": "2023-11-07T05:31:56Z",
      "attempt": 123,
      "maxAttempts": 123,
      "queue": "<string>",
      "filename": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "page": 123,
    "total": 123,
    "limit": 123,
    "count": 123,
    "sort": "asc",
    "sortFields": [
      "createdAt"
    ]
  }
}

GET

report

extractPII

List Extract PII jobs

curl --request GET \
  --url https://api.uat.frankie.one/v2/report/extractPII \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'X-Frankie-RequestID: <x-frankie-requestid>' \
  --header 'api_key: <api-key>'

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "jobs": [
    {
      "jobId": "<string>",
      "status": "CREATED",
      "operationType": "REPORT",
      "operationName": "EXTRACT_PII",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "attemptedAt": "2023-11-07T05:31:56Z",
      "finalizedAt": "2023-11-07T05:31:56Z",
      "attempt": 123,
      "maxAttempts": 123,
      "queue": "<string>",
      "filename": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "page": 123,
    "total": 123,
    "limit": 123,
    "count": 123,
    "sort": "asc",
    "sortFields": [
      "createdAt"
    ]
  }
}

Authorizations

api_key

string

header

required

Headers

api_key

string

required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

X-Frankie-RequestID

string

required

GUID identifier for request

Example:

"82988375-1F9C-40C7-8543-ECCA0D94CC7C"

X-Frankie-CustomerID

string

required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID

string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

X-Frankie-Username

string

Username provided by API caller

Example:

"fred.flintstone@frankieone.com"

Query Parameters

page

integer

The page number that you want to retrieve for the list query

limit

integer

default:20

Limit the number of items that will be returned as part of the request

Required range: x >= 1

statuses

enum<string>[]

Filter jobs by status. Multiple statuses can be provided to filter by any of them.

Status of the job

Available options:

CREATED,

IN_PROGRESS,

COMPLETED,

FAILED,

CANCELLED

sort

enum<string>

Order of the sort fields will be sorted upon

Available options:

asc,

desc

sortFields

enum<string>[]

The fields that were used to sort the items in the response

Available options:

createdAt

Response

Response for listing Extract PII jobs

requestId

string

required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

jobs

object[]

required

Show child attributes

Introduction

KYC V2 API

Transaction and Activity Monitoring V2 API

KYB V2 API

Core V2 API

List Extract PII jobs

Authorizations

Headers

Query Parameters

Response