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>'

import requests

url = "https://api.uat.frankie.one/v2/report/extractPII"

headers = {
    "api_key": "<api-key>",
    "X-Frankie-RequestID": "<x-frankie-requestid>",
    "X-Frankie-CustomerID": "<x-frankie-customerid>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    api_key: '<api-key>',
    'X-Frankie-RequestID': '<x-frankie-requestid>',
    'X-Frankie-CustomerID': '<x-frankie-customerid>'
  }
};

fetch('https://api.uat.frankie.one/v2/report/extractPII', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uat.frankie.one/v2/report/extractPII",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Frankie-CustomerID: <x-frankie-customerid>",
    "X-Frankie-RequestID: <x-frankie-requestid>",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uat.frankie.one/v2/report/extractPII"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("X-Frankie-RequestID", "<x-frankie-requestid>")
	req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.uat.frankie.one/v2/report/extractPII")
  .header("api_key", "<api-key>")
  .header("X-Frankie-RequestID", "<x-frankie-requestid>")
  .header("X-Frankie-CustomerID", "<x-frankie-customerid>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uat.frankie.one/v2/report/extractPII")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-RequestID"] = '<x-frankie-requestid>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'

response = http.request(request)
puts response.read_body

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "jobs": [
    {
      "jobId": "<string>",
      "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,
    "sortFields": []
  }
}

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>'

import requests

url = "https://api.uat.frankie.one/v2/report/extractPII"

headers = {
    "api_key": "<api-key>",
    "X-Frankie-RequestID": "<x-frankie-requestid>",
    "X-Frankie-CustomerID": "<x-frankie-customerid>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    api_key: '<api-key>',
    'X-Frankie-RequestID': '<x-frankie-requestid>',
    'X-Frankie-CustomerID': '<x-frankie-customerid>'
  }
};

fetch('https://api.uat.frankie.one/v2/report/extractPII', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uat.frankie.one/v2/report/extractPII",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Frankie-CustomerID: <x-frankie-customerid>",
    "X-Frankie-RequestID: <x-frankie-requestid>",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uat.frankie.one/v2/report/extractPII"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("X-Frankie-RequestID", "<x-frankie-requestid>")
	req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.uat.frankie.one/v2/report/extractPII")
  .header("api_key", "<api-key>")
  .header("X-Frankie-RequestID", "<x-frankie-requestid>")
  .header("X-Frankie-CustomerID", "<x-frankie-customerid>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uat.frankie.one/v2/report/extractPII")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-RequestID"] = '<x-frankie-requestid>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'

response = http.request(request)
puts response.read_body

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "jobs": [
    {
      "jobId": "<string>",
      "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,
    "sortFields": []
  }
}

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