These are the JSON structures that are returned as API responses.

General​

Location​

A particular place in the world.

Example​

{
  "address_one": "123 Fake St",
  "address_two": "Apt 3",
  "city": "New York",
  "region": null,
  "postal_code": "10011",
  "state": "NY",
  "country": "US"
}

User Session​

Metadata about a web session that interacted with parallelmarkets.com

Example​

{
  "maybe_anonymizing_proxy": false,
  "country_code": "US",
  "region": "North Carolina",
  "city": "Durham"
}

Dates and Timestamps​

All date and date time (aka, timestamp) information is provided in standard ISO-8601 format. Dates will be provided as YYYY-MM-DD strings (i.e., "2021-06-10"). Timestamps will be provided as string UTC dates with time in the format YYYY-MM-DDThh:mm:ssZ (i.e., "2021-06-29T13:32:21Z").

Case Management​

Record​

An individual or business linked to your case management instance.

Risk monitoring statuses:

• enabled - Risk monitoring is enabled and potential risk matches will be processed on an ongoing basis
• disabled - Risk monitoring has been disabled for this individual
• initiating - Risk monitoring for this individual is being configured

Example​

{
  "created_at": "2022-08-29T15:14:44Z",
  "current_status": {
    "notes": "This is a test note.",
    "set_at": "2023-05-17T15:14:44Z",
    "set_by": {
      "email": "joe@acme.com",
      "first_name": "Joe",
      "last_name": "Bloggs"
    },
    "status": "approved"
  },
  "id": "UG9kVXNlclJlY29yZDoyNDQw",
  "identity_link_established_at": "2022-08-29T15:14:44Z",
  "identity_link_expiration_requested_by": null,
  "identity_link_expires_at": null,
  "type": "individual",
  "external_id": "unique_external_id_123",
  "user_deactivated_at": null,
  "user_requested_deletion_at": null
}

A comment for an individual or business entity record.

Example​

{
  "text": "This is a test comment.",
  "created_at": "2023-05-17T15:14:44Z",
  "created_by": {
    "email": "joe@acme.com",
    "first_name": "Joe",
    "last_name": "Bloggs"
  },
  "source": "user"
}

Record Status​

The current status of an individual or business entity.

Example​

{
  "notes": "This is a test note.",
  "set_at": "2023-05-17T15:14:44Z",
  "set_by": {
    "email": "joe@acme.com",
    "first_name": "Joe",
    "last_name": "Bloggs"
  },
  "status": "approved",
  "source": "user"
}

Risk Match​

A risk match for an individual or business.

Example​

{
  "change_id": "UG9kVXNlckRhdGFFbnRyeTo5NTA=",
  "created_at": "2023-06-07T09:54:33Z",
  "id": "VXNlclJpc2tNb25pdG9yTWF0Y2g6NDU=",
  "match_details": {
    "adverse_media": true,
    "birth_date": "1957-03-10",
    "currently_sanctioned": true,
    "deceased": true,
    "disqualified_director": false,
    "financial_regulator": true,
    "first_name": "Joe",
    "insolvent": false,
    "last_name": "Sanctioned",
    "law_enforcement": true,
    "middle_name": "PATRICK",
    "nationalities": ["RU"],
    "pep": true,
    "previously_sanctioned": false,
    "score": 100
  },
  "review_details": {
    "aliases": [
      {
        "first_name": "Joseph",
        "middle_name": "Patrick",
        "last_name": "Sanctioned"
      }
    ],
    "notes": [
      "Listed as a sanctioned individual by the United States Office of Foreign Assets Control (OFAC)"
    ],
    "image_url": "https://ari-cdn.parallelmarkets.com/cdn/content/123.PNG",
    "articles": [
      {
        "original_url": "https://example.com/123",
        "archival_url": "https://example.com/123.pdf",
        "date_collected": "2022-06-13",
        "categories": ["Sanction (current)", "Insolvent"]
      }
    ],
    "current_sanctions": ["Office of Foreign Assets Control (OFAC)"],
    "former_sanctions": ["Japan Ministry of Finance"],
    "pep_tier": "PEP Tier 2",
    "addresses": [
      {
        "address_one": "11 11th st",
        "address_two": "11L",
        "city": "Brooklyn",
        "country": "US",
        "postal_code": "11201",
        "region": null,
        "state": "NY"
      }
    ]
  },
  "resolution": "likely-match",
  "resolution_id": "UG9kVXNlclJpc2tNYXRjaDoxMTU=",
  "resolution_notes": "Name, DOB, Nationality and picture indicate a likely match.",
  "resolved_at": "2023-06-07T09:54:33Z",
  "resolved_by": {
    "email": "reviewer@acme.com",
    "first_name": "John",
    "last_name": "Reviewer"
  },
  "source": "user"
}

Risk Match Review Details​

Information about a sanctioned (or otherwise risky) entity for review when determining the resolution of a potential match to an individual or business.

Example​

{
  "aliases": [
    {
      "first_name": "Joseph",
      "middle_name": "Patrick",
      "last_name": "Sanctioned"
    }
  ],
  "notes": [
    "Listed as a sanctioned individual by the United States Office of Foreign Assets Control (OFAC)"
  ],
  "image_url": "https://ari-cdn.parallelmarkets.com/cdn/content/123.PNG",
  "articles": [
    {
      "original_url": "https://example.com/123",
      "archival_url": "https://example.com/123.pdf",
      "date_collected": "2022-06-13",
      "categories": ["Sanction (current)", "Insolvent"]
    }
  ],
  "current_sanctions": ["Office of Foreign Assets Control (OFAC)"],
  "former_sanctions": ["Japan Ministry of Finance"],
  "pep_tier": "PEP Tier 2",
  "addresses": [
    {
      "address_one": "11 11th st",
      "address_two": "11L",
      "city": "Brooklyn",
      "country": "US",
      "postal_code": "11201",
      "region": null,
      "state": "NY"
    }
  ]
}

Risk Match Review Article​

Published information about a sanctioned (or otherwise risky) entity.

Individual Record Details​

A record for an individual in the Case Management system.

Assertion types:

• income - Accreditation is based on the income test
• net-worth - Accreditation is based on the net-worth test
• evaluator-assertion - Accreditation is based on a third party evaluation (CPA, lawyer, or broker dealer reviewed accreditation status)
• professional-license - The person holds a professional license that qualifies them for accreditation

Risk monitoring statuses:

• enabled - Risk monitoring is enabled and potential risk matches will be processed on an ongoing basis
• disabled - Risk monitoring has been disabled for this individual
• initiating - Risk monitoring for this individual is being configured

Business Record Details​

A record for a business in the Case Management system.

Assertion types:

• worth - Accreditation is based on worth (only used for businesses)
• evaluator-assertion - Accreditation is based on a third party evaluation (CPA, lawyer, or broker dealer reviewed accreditation status)
• accredited-owners - Accreditation is based on all owners being accredited

Risk monitoring statuses:

• enabled - Risk monitoring is enabled and potential risk matches will be processed on an ongoing basis
• disabled - Risk monitoring has been disabled for this business
• initiating - Risk monitoring for this business is being configured

Record File​

A file associated with a Case Management record.

Record File Type​

An enumerated type used for Record File document classification.

Secondary Tax ID​

A secondary tax identification number for an individual or business.

Record Trait​

Record traits allow you, as a partner, to store custom attributes about an individual or business. You can read more about configuring record traits on the partner support page.

Accreditation Reviewer Note​

An object representing a current reviewer note for a given accreditation.

Example​

{
  "text": "Waiting for additional documentation from subject.",
  "created_at": "2023-09-01T16:00:00Z"
}

Individual Data Structures​

Individual Profile​

An individual person's profile details.

Example​

{
  "email": "test@example.com",
  "first_name": "Wyman",
  "last_name": "Manderly"
}

Individual Accreditation​

An object representing an accreditation application by an individual.

Accreditation application statuses:

• current - Accreditation is currently valid
• unsubmitted - Accreditation application has been started but not yet completed by the applicant
• pending - Accreditation application is in review
• submitter_pending - Accreditation application is awaiting additional information or documentation from the submitter
• third_party_pending - Accreditation application is awaiting documentation from a third party evaluator
• canceled - Accreditation application has been canceled due to submitter request or unresponsive third party evaluator
• expired - Accreditation has expired and is no longer valid
• rejected - Accreditation attempt was unsuccessful due to a failure to meet requirements

Assertion types:

• income - Accreditation is based on the income test
• net-worth - Accreditation is based on the net-worth test
• evaluator-assertion - Accreditation is based on a third party evaluation (CPA, lawyer, or broker dealer reviewed accreditation status)
• professional-license - The person holds a professional license that qualifies them for accreditation

Accreditation application rejection reasons:

• expired-document - One or more documents have expired
• mismatched-name - Name in document doesn't match applicant name
• income-invalid - Income doesn't meet necessary threshold
• net-worth-invalid - Net worth doesn't meet necessary threshold
• wrong-document-type - Wrong document type submitted
• evaluator-rejection - Individual's CPA/Lawyer/Investment Advisor declined to accredit
• evaluator-letter-invalid - Letter wasn't dated within 90 days, didn't mention if docs were reviewed or was not from CPA/BD/Attorney
• invalid-crd-number - CRD number is invalid

Example​

{
  "assertion_type": "income",
  "change_ids": ["UG9kVXNlckRhdGFFbnRyeTo5NTA="],
  "created_at": "2023-09-01T12:00:00Z",
  "submitted_at": "2023-09-01T12:00:00Z",
  "started_at": "2023-09-01T16:00:00Z",
  "certified_at": "2023-09-01T16:00:00Z",
  "expires_at": "2023-11-01T16:00:00Z",
  "rejected_at": null,
  "canceled_at": null,
  "id": "VXNlckFjY3JlZGl0YXRpb246MQ==",
  "status": "current",
  "first_name": "Snake",
  "last_name": "Plissken",
  "documents": [
    {
      "download_url": "https://api.parallelmarkets.com/files/123?token=abc123",
      "download_url_expires": 30,
      "type": "certification-letter"
    }
  ],
  "reviewer_note": {
    "text": "Waiting for additional documentation from subject.",
    "created_at": "2023-09-01T16:00:00Z"
  }
}

Individual Consistency Summary​

An object representing the consistency summary results for an individual.

Consistency levels:

• high - records search found a high confidence match (an exact match)
• medium - records search found a medium confidence match (not an exact match, there may be some variation in details, like first name spelling)
• low - records search found a low confidence match (a weak or partial match for some details)
• none - records search found no match

Identity document validity results:

• valid - the identity document is valid and not expired
• valid_maybe_expired - the identity document is valid, but we were unable to verify expiration date
• expired - the identity document is expired
• unreadable - the identity document is unreadable

Example​

{
  "address_id_match": true,
  "address_id_value": "123 Fake St, New York, NY, 10011, US",
  "address_records_match_level": "high",
  "address_submitter_match": true,
  "birth_date_id_match": true,
  "birth_date_id_value": "1969-12-31",
  "birth_date_records_match_level": "high",
  "id_validity": "valid",
  "id_matching_sides": true,
  "id_selfie_similarity_level": null,
  "name_id_match": true,
  "name_id_value": "Jonathan O'Neill",
  "name_records_match_level": "medium",
  "name_tax_match": true,
  "name_tax_value": "Jonathan O'Neill",
  "overall_records_match_level": "high",
  "possibly_deceased": false,
  "selfie_liveness_probability_level": null,
  "tin_multiple_match": false,
  "tin_records_match_level": "high"
}

Individual Identity Document Consistency Details​

An object representing the consistency detail results for an individual's identity document.

Identity document validity results:

• valid - the identity document is valid and not expired
• valid_maybe_expired - the identity document is valid, but we were unable to verify expiration date
• expired - the identity document is expired
• unreadable - the identity document is unreadable

Example​

{
  "address_id_match": true,
  "address_id_value": "123 Fake St, New York, NY, 10011, US",
  "birth_date_id_match": true,
  "birth_date_id_value": "1969-12-31",
  "id_country": "US",
  "id_expiration": "2029-12-31",
  "id_number": "111222333",
  "id_selfie_similarity_level": null,
  "id_side": "front",
  "id_validity": "valid",
  "name_id_match": true,
  "name_id_value": "Jonathan O'Neill",
  "selfie_liveness_probability_level": null
}

Individual Risk Monitor Match​

Information about a potential match between an individual and a sanctioned (or otherwise risky) entity.

Example​

{
  "adverse_media": true,
  "birth_date": "1958-04-08",
  "currently_sanctioned": true,
  "deceased": false,
  "disqualified_director": false,
  "financial_regulator": false,
  "first_name": "Alyona",
  "insolvent": false,
  "last_name": "Semenov",
  "law_enforcement": true,
  "middle_name": null,
  "nationalities": ["RU"],
  "pep": false,
  "previously_sanctioned": false,
  "score": 73
}

Business Data Structures​

Business Profile​

The profile details for a given business.

Business types:

• Public Charity - A public charity as defined in Section 501(c)(3) of the Internal Revenue Code
• Private Foundation - A private foundation as defined in Section 501(c)(3) of the Internal Revenue Code
• S Corporation - An S-Corp as defined in Subchapter S of Chapter 1 of the Internal Revenue Code
• C Corporation - A C-Corp as defined in the Internal Revenue Code
• Irrevocable Trust - Any irrevocable business or personal trust described in Section 501(a) of the Securities Act of 1933, as amended
• Revocable Trust - Any revocable business or personal trust described in Section 501(a) of the Securities Act of 1933, as amended
• Other Trust Classification - Any other business or personal trust described in Section 501(a) of the Securities Act of 1933, as amended
• Limited Liability Company - A partnership organized as a limited liability company under the laws of its state of formation (includes single-member LLCs and most self-directed IRAs or 401(k) plans)
• Limited Partnership - A partnership organized as a limited partnership under the laws of its state of formation
• Family Office - A "family office" as defined in Rule 202(a)(11)(G)–1 under the Investment Advisers Act of 1940
• Foreign Corporation - A corporation formed under the laws of a nation other than the United States
• Other Company Classification - Any other type of company as defined in the Internal Revenue Code
• Partnership - A partnership organized under the laws of its state of formation
• Nominee - An entity given limited authority to act on behalf of the entity during its formation
• Eligible Introducer - A regulated entity that can perform KYC/CDD on behalf of another entity
• Fund of Funds - An investment vehicle that pools capital from multiple investors to invest in other underlying funds
• US Government Entity - An entity that is part of the United States federal, state, or local government
• Non-US Commercial Government Entity - Any entity located outside the United States that is owned by a foreign government
• Regulated Entity - An entity subject to oversight and rules from a regulatory authority
• Non-Exempt Regulated Entity - An entity that falls under the purview of specific government regulations and does not meet the criteria for exemption from those requirements
• US Listed Company - A company that is publicly traded on a stock exchange in the United States
• Non-US Listed Company - A company that is publicly traded on a stock exchange outside the United States
• Introduced Investor - An entity that has been referred to an investment opportunity by another party

Example​

{
  "name": "CompuGlobalHyperMegaNet, Inc.",
  "business_type": "Limited Liability Company",
  "primary_contact": {
    "email": "test@example.com",
    "first_name": "Wyman",
    "last_name": "Manderly"
  }
}

Business Accreditation​

A representation of an accreditation application by a business.

Accreditation statuses:

• current - Accreditation is currently valid
• unsubmitted - Accreditation application has been started but not yet completed by the applicant
• pending - Accreditation application is in review
• submitter_pending - Accreditation application is awaiting additional information or documentation from the submitter
• third_party_pending - Accreditation application is awaiting documentation from a third party evaluator
• canceled - Accreditation application has been canceled due to submitter request, unresponsive third party evaluator, or unresponsive / unaccredited owner
• expired - Accreditation has expired and is no longer valid
• rejected - Accreditation attempt was unsuccessful due to a failure to meet requirements

Assertion types:

• worth - Accreditation is based on worth (only used for businesses)
• evaluator-assertion - Accreditation is based on a third party evaluation (CPA, lawyer, or broker dealer reviewed accreditation status)
• accredited-owners - Accreditation is based on all owners being accredited

Accreditation application rejection reasons:

• expired-document - One or more documents have expired
• mismatched-name - Name in document doesn't match applicant name
• total-worth-invalid - Total worth doesn't meet necessary threshold
• wrong-document-type - Wrong document type submitted
• evaluator-rejection - Entity's CPA/Lawyer/Investment Advisor declined to accredit
• evaluator-letter-invalid - Letter wasn't dated within 90 days, didn't mention if docs were reviewed or was not from CPA/BD/Attorney
• owners-are-not-accredited - One or more owners are not accredited
• mismatched-list-of-owners - Business owners list in document doesn't match provided list of owners

Example​

{
  "assertion_type": "income",
  "change_ids": ["UG9kVXNlckRhdGFFbnRyeTo5NTA="],
  "created_at": "2023-09-01T12:00:00Z",
  "submitted_at": "2023-09-01T12:00:00Z",
  "started_at": "2023-09-01T16:00:00Z",
  "certified_at": "2023-09-01T16:00:00Z",
  "expires_at": "2023-11-01T16:00:00Z",
  "rejected_at": null,
  "canceled_at": null,
  "id": "VXNlckFjY3JlZGl0YXRpb246MQ==",
  "status": "current",
  "name": "Compu-Global-Hyper-Mega-Net, Inc.",
  "documents": [
    {
      "download_url": "https://api.parallelmarkets.com/files/123?token=abc123",
      "download_url_expires": 30,
      "type": "certification-letter"
    }
  ],
  "reviewer_note": {
    "text": "Waiting for additional documentation from subject.",
    "created_at": "2023-09-01T16:00:00Z"
  }
}

Business Consistency Summary​

An object representing the consistency summary results for a business.

Consistency levels:

• high - records search found a high confidence match (an exact match)
• medium - records search found a medium confidence match (not an exact match, there may be some variation in details, like first name spelling)
• low - records search found a low confidence match (a weak or partial match for some details)
• none - records search found no match

Example​

{
  "address_records_match_level": "high",
  "address_submitter_match": true,
  "name_records_match_level": "medium",
  "name_tax_match": true,
  "name_tax_value": "Hic Sunt Leones LLC",
  "overall_records_match_level": "high",
  "tin_multiple_match": false,
  "tin_records_match_level": "high"
}

Business Risk Monitor Match​

Information about a potential match between a business and a sanctioned (or otherwise risky) entity.

Example​

{
  "adverse_media": true,
  "currently_sanctioned": true,
  "disqualified_director": true,
  "financial_regulator": true,
  "insolvent": true,
  "law_enforcement": true,
  "name": "Hic Sunt Leones LLC",
  "pep": true,
  "previously_sanctioned": true,
  "score": 97,
  "website": "http://hic.sunt.leon.example.com"
}

Control Person​

A reference to a control person (an individual) containing information necessary to fetch additional details about the individual.

Examples​

A full reference for an individual that has submitted and consented to share identity details will contain an id field.

{
  "id": "VXNlcjoxMDMyOQ==",
  "title": "Headmaster",
  "type": "individual",
  "profile": {
    "email": "apwbd@hogwarts.co.uk",
    "first_name": "Albus",
    "last_name": "Dumbledore"
  }
}

A partial reference for an individual that has not consented to share identity details:

{
  "title": "Potions Master",
  "type": "individual",
  "profile": {
    "first_name": "Severus",
    "last_name": "Snape"
  }
}

Beneficial Owner​

A reference to a beneficial owner (an individual or a business) containing information necessary to fetch additional details about the owner individual or business.

Examples​

A full reference for a business that has submitted and consented to share identity details will contain an id field.

{
  "id": "QnVzaW5lc3M6MjEzOQ==",
  "type": "business",
  "ownership_percent": 0.5,
  "profile": {
    "business_type": "partnership-llc",
    "name": "Quicksilver Inc",
    "primary_contact": {
      "email": "r@sun.cc",
      "first_name": "Regulus",
      "last_name": "Sun"
    }
  }
}

A partial reference for an individual that has not consented to share identity details:

{
  "type": "individual",
  "ownership_percent": 0.25,
  "profile": {
    "email": "nero@aug.us",
    "first_name": "Nero",
    "last_name": "Augustus"
  }
}