Requirement

The Requirement object defines the personal details, actions, or validations requested by the initiator of an activity. It ensures flexibility by allowing the recipient (receptor) to decide which details to share while meeting the requirements of the activity.

Requirement Type

The Requirement Type specifies the format or nature of the requested data or action in an activity.

Available in: GET (response only).

Type

Description

RTP_001

Requires the execution of a BioFace Authentication Flow.

RTP_002

Requests personal details in the form of structured data values (JSON object).

RTP_003

Requests images, such as selfies or identity document photos (front and back) as a binary file.

RTP_004

Requests a combination of structured personal details (RTP_002) OR image data (RTP_003).

RTP_005

Requests a combination of structured personal details (RTP_002) AND image data (RTP_003).

Requirement Category

The Requirement Category groups requirements into logical categories based on the type of information being requested.

Available in: GET (response only).

Requirement Code

The Requirement Code uniquely identifies a group of personal detail requirements, requests, or actions within an activity. Each Requirement Item specifies the precise data or action associated with the requirement, outlining what will be included in the request. The table below lists all available Requirement Codes and their corresponding Requirement Items, which can be included in a request.

Available in: POST (request) and GET (response).

Code

Description

Requirement Items

RQ_001

BioFace Authentication

RQ_002

Identity Trust

IDT_001 Member Since
IDT_002 Identity Trust Score
IDT_003 Identity Trust Score Level
IDT_004 IDV Timestamp

RQ_003

Selfie

RQ_004

Personal Information

PIF_001 Profile Name
PIF_002 Fullname
PIF_003 Surname
PIF_004 Given names
PIF_005 Date of Birth
PIF_006 Gender
PIF_007 Marital Status

RQ_005

Nationality

RQ_006

Identity Document

IDC_001 Frontside image
IDC_002 Backside image
IDC_003 Document Information

RQ_007

Address

RQ_008

Phone

RQ_009

RQ_010

Government Tax ID

RQ_011

Occupation

RQ_012

Employment

RQ_013

Compliance

RQ_014

Income

RQ_015

Proof of Residence

RQ_016

Proof of Income

RQ_017

Proof of Employment

RQ_018

Proof of Education

RQ_019

Proof of Ownership

RQ_020

Proof of Funds

RQ_021

Proof of Insurance

RQ_022

Legal Document

RQ_023

House Owner

RQ_024

Housing Monthly Cost

Accepted Requirements

The Accepted Requirement items uniquely identify the details of the elements associated with the Requirement Items. These accepted elements are grouped under a Requirement Code and represent the data included in the response.

The table below lists all available Acceptance Codes returned as part of the response.

Requirement

Property

Example

RQ_002

items

[
  {
    "code": "IDT_001", // Member Since
    "data": {
      "value": 1704085200000
    }
  },
  {
    "code": "IDT_002", // Identity Trust Score
    "data": {
      "value": 450
    }
  },
  {
    "code": "IDT_003", // Identity Trust Score Level
    "data": {
      "value": "POOR"
    }
  },
  {
    "code": "IDT_004", // IDV Timestamp
    "data": {
      "datetime": 1704085200000
    }
  }
]

RQ_003

data

{
  "url": "https://url.com/my-selfie.png"
}

RQ_004

items

[
  {
    "code": "PIF_001", // Profile Name
    "data": {
      "value": "John Doe"
    }
  },
  {
    "code": "PIF_002", // Fullname
    "data": {
      "value": "John Martin Doe"
    }
  },
  {
    "code": "PIF_003", // Surname
    "data": {
      "value": "Doe"
    }
  },
  {
    "code": "PIF_004", // Given names
    "data": {
      "value": "John Martin"
    }
  },
  {
    "code": "PIF_005", // Date of Birth
    "data": {
      "value": "1984-12-31"
    }
  },
  {
    "code": "PIF_006", // Gender
    "data": {
      "value": "M"
    }
  },
  {
    "code": "PIF_007", // Marital Status
    "data": {
      "value": "Single"
    }
  }
]

RQ_005

data

{
  "nationality": "US"
}

RQ_006

items

[
  {
    "code": "IDC_001", // Frontside image
    "data": {
      "url": "https://url.com/front-image.png"
    }
  },
  {
    "code": "IDC_002", // Backside image
    "data": {
      "url": "https://url.com/back-image.png"
    }
  },
  {
    "code": "IDC_003", // Document Information
    "data": {
      "fullname": "John Martin Doe",
      "given_names": "John Martin",
      "surnames": "Doe",
      "first_name": "John",
      "middle_name": "Martin",
      "surname": "Doe",
      "second_surname": null,
      "gender": "M",
      "age": "40",
      "date_of_birth": "1984-12-31",
      "marital_status": "Single",
      "height": "5'10''",
      "weight": "220lb",
      "eyes_color": "Blue",
      "hair_color": "Black",
      "nationality": "US",
      "place_of_birth": "US",
      "address": "1853 E Orleans St.",
      "city": "Philadelphia",
      "state": "Pennsylvania",
      "zipcode": "19134",
      "address_country": "US",
      "category": "Government issued-id",
      "type": "PASSPORT",
      "type_name": "Passport",
      "id_number": "987654321",
      "alternate_number": "12345678",
      "document_place_of_issue": "US",
      "document_issuing_state": "PA",
      "document_issuing_state_name": "Pennsylvania",
      "document_issuing_country": "US",
      "document_issuing_date": "2020-01-01",
      "document_expiration_date": "2029-12-31",
      "rfid_present": true
    }
  }
]

RQ_007

data

{
  "country": "US",
  "state": "Pennsylvania",
  "city": "Philadelphia",
  "address": "1853 E Orleans St.",
  "zipcode": "19134"
}

RQ_008

data

{
  "country_code": "US",
  "number": "9876543210"
}

RQ_009

data

{
  "recipient": "[email protected]"
}

RQ_010

data

{
  "country": "PE",
  "type": "BT_001",
  "number": "456BH9312B1"
}

RQ_011

data

{
  "code": "OCC_004"
}

RQ_012

data

{
  "status": "EMS_001",
  "title": "Engineer",
  "start_date": "2024-01-01",
  "end_date": "2028-12-31",
  "employer": {
    "name": "Microsoft Corp.",
    "address": {
      "country": "US",
      "city": "Philadelphia",
      "state": "Pennsylvania",
      "address": "1801 E Orleans St.",
      "zipcode": "19134"
    }
  }
}

RQ_014

data

{
  "currency": "USD",
  "income": 300000,
  "symbol": "$"
}

RQ_015

data

{
  "type": "DCT_001",
  "name": "Document of residence",
  "owner": "Donald Trump",
  "issuing_entity": "US Government",
  "issuing_date": "2020-01-01",
  "expiration_date": "2030-05-30",
  "url": "https://url.com/document"
}

RQ_016

data

{
  "type": "DCT_002",
  "name": "Payment bill",
  "owner": "Donald Trump",
  "issuing_entity": "Microsoft Corp.",
  "issuing_date": "2020-01-01",
  "url": "https://url.com/document"
}

RQ_017

data

{
  "type": "DCT_003",
  "name": "Employment contract",
  "owner": "Donald Trump",
  "issuing_entity": "Google LLC",
  "issuing_date": "2020-01-01",
  "expiration_date": "2030-05-30",
  "url": "https://url.com/document"
}

RQ_018

data

{
  "type": "DCT_004",
  "name": "Graduation document",
  "owner": "Donald Trump",
  "issuing_entity": "Georgia University",
  "issuing_date": "1985-01-01",
  "url": "https://url.com/document"
}

RQ_019

data

{
  "type": "DCT_005",
  "name": "House ownership",
  "owner": "Donald Trump",
  "issuing_entity": "US Government",
  "issuing_date": "2020-01-01",
  "url": "https://url.com/document"
}

RQ_020

data

{
  "type": "DCT_006",
  "name": "Funds inform",
  "owner": "Donald Trump",
  "issuing_entity": "US Government",
  "issuing_date": "2020-01-01",
  "url": "https://url.com/document"
}

RQ_021

data

{
  "type": "DCT_007",
  "name": "Insurance contract",
  "owner": "Donald Trump",
  "issuing_entity": "US Government",
  "issuing_date": "2020-01-01",
  "expiration_date": "2030-05-30",
  "url": "https://url.com/document"
}

RQ_022

data

{
  "type": "DCT_008",
  "name": "Divorce agreement",
  "owner": "Donald Trump",
  "issuing_entity": "US Government",
  "issuing_date": "2020-01-01",
  "url": "https://url.com/document"
}

RQ_023

data

{
  "is_owner": false
}

RQ_024

data

{
  "currency": "USD",
  "symbol": "$",
  "cost": 80000
}

PreviousActivity NextObjects

Last updated 3 months ago