# Parallel Developer Documentation Legacy – v1.x

For up-to-date documentation, see the **[latest version](https://developer.parallelmarkets.com/docs/server/data-structures)** (Current – v2.x).

Version: Legacy – v1.x

## Main Content

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

## General

### Location

A particular place in the world.

| Name         | Description  |
|--------------|--------------|
| `address_one`| Street address |
| `address_two`| Second address line (apartment, suite, block, etc) |
| `city`      | Name of city |
| `region`    | Region is available for non-US addresses |
| `postal_code`| A postal code (this will be a zip code for a US-based address) |
| `state`     | State for US-based addresses |
| `country`   | 2 letter [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code |

#### Example

```json
{
  "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

| Name                             | Description  |
|----------------------------------|--------------|
| `maybe_anonymizing_proxy`       | Boolean; `false` if the user did not use an anonymizing proxy (e.g. TOR, Public VPN) when submitting linked information. |
| `country_code`                  | An alpha-2 ISO 3166 string indicating the country in which the user appeared to be when submitting linked information. Null if unknown. |
| `region`                        | A string listing the name of the state or region in which the user appeared to be when submitting linked information. Null if unknown. |
| `city`                          | A string listing the name of the city in which the user appeared to be when submitting linked information. Null if unknown. |

#### Example

```json
{
  "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](https://en.wikipedia.org/wiki/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").

## Profile

### Business Profile

The profile details for a given business.

| Name             | Description  |
|------------------|--------------|
| `name`          | Name of business |
| `business_type` | One of the business types below |
| `primary_contact`| An [Individual Profile](https://developer.parallelmarkets.com/docs/1.x/server/data-structures/#individual-profile) representing the primary contact for the business (may be `null` based on permissions) |

Business types:

- `Public Charity`
- `Private Foundation`
- `S Corporation`
- `C Corporation`
- `Irrevocable Trust`
- `Revocable Trust`
- `Other Trust Classification`
- `Limited Liability Company`
- `Limited Partnership`
- `Family Office`
- `Foreign Corporation`
- `Other Company Classification`
- `Partnership`
- `Nominee`
- `Eligible Introducer`
- `Fund of Funds`
- `US Government Entity`
- `Non-US Commercial Government Entity`
- `Regulated Entity`
- `Non-Exempt Regulated Entity`
- `US Listed Company`
- `Non-US Listed Company`
- `Introduced Investor`

Note that the name used here is the current "common" name the business has set in their profile settings, which may not be the same as the business's legal names used in accreditation or identity flows.

#### Example

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

### Individual Profile

An individual person's profile details.

| Name       | Description  |
|------------|--------------|
| `email`    | Person's email address (may be `null` based on permissions) |
| `first_name`| First name of person |
| `last_name` | Last name of person |

#### Example

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

## Accreditation

### Accreditation Document

| Name                       | Description  |
|----------------------------|--------------|
| `download_url`            | URL where the document is available. |
| `download_url_expires`    | Number of seconds until the token in the `download_url` expires |
| `type`                    | This will always be `certification-letter` |
| `category`                | **Only available for [Case Management](https://developer.parallelmarkets.com/docs/1.x/server/case-management-api/introduction)** |

#### Example

```json
{
  "download_url": "https://api.parallelmarkets.com/files/business_accreditation_document/123?token=abc123def456",
  "download_url_expires": 30,
  "type": "certification-letter"
}
```

### Business Accreditation

A representation of an accreditation attempt by a business.

| Name               | Description  |
|--------------------|--------------|
| `id`              | Unique identifier for the accreditation |
| `status`          | One of the statuses listed below |
| `expires_at`      | Unix timestamp of when accreditation certification letter expires |
| `assertion_type`  | One of the types listed below |
| `created_at`      | Unix timestamp of when the accreditation request was submitted by the user |
| `certified_at`    | Unix timestamp of when the accreditation was certified and accreditation certification letter was issued |
| `name`            | The name of the company that has been accredited |
| `documents`       | A list of [Accreditation Document](https://developer.parallelmarkets.com/docs/1.x/server/data-structures/#accreditation-document) s |
| `rejection_reason` | One of the reasons listed below (if the accreditation is rejected) |

Accreditation statuses:

- `current`
- `pending`
- `submitter_pending`
- `third_party_pending`
- `canceled`
- `expired`
- `rejected`

Assertion types:

- `worth`
- `evaluator-assertion`
- `accredited-owners`

#### Example

```json
{
  "assertion_type": "income",
  "certified_at": 1568474142,
  "created_at": 1568560542,
  "expires_at": 1571152542,
  "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"
  }]
}
```

### Individual Accreditation

An object representing an accreditation attempt by an individual.

| Name                 | Description  |
|----------------------|--------------|
| `id`                | Unique identifier for the accreditation |
| `status`            | One of the statuses listed below |
| `expires_at`        | Unix timestamp of when accreditation certification letter expires |
| `assertion_type`    | One of the types listed below |
| `created_at`        | Unix timestamp of when the accreditation request was submitted by the user |
| `certified_at`      | Unix timestamp of when the accreditation was certified and accreditation certification letter was issued |
| `first_name`        | The first name of the accredited individual |
| `last_name`         | The last name of the accredited individual |
| `documents`         | A list of [Accreditation Document](https://developer.parallelmarkets.com/docs/1.x/server/data-structures/#accreditation-document) s |
| `rejection_reason`   | One of the reasons listed below (if the accreditation is rejected) |

Accreditation statuses:

- `current`
- `pending`
- `submitter_pending`
- `third_party_pending`
- `canceled`
- `expired`
- `rejected`

Assertion types:

- `income`
- `net-worth`
- `evaluator-assertion`
- `professional-license`

#### Example

```json
{
  "assertion_type": "income",
  "certified_at": 1568474142,
  "created_at": 1568560542,
  "expires_at": 1571152542,
  "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"
  }]
}
```

## Identity

### Beneficial Owner Reference

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

| Name                      | Description  |
|---------------------------|--------------|
| `id`                     | (Optional) Unique identifier for the beneficial owner entity |
| `type`                   | `individual` or `business` |
| `ownership_percent`      | The fractional amount of direct ownership this entity has of the business (float number > 0.0 and ≤ 1.0) |
| `profile`                | A [Business](https://developer.parallelmarkets.com/docs/1.x/server/data-structures/#business-profile) or [Individual](https://developer.parallelmarkets.com/docs/1.x/server/data-structures/#individual-profile) profile |

#### Example

```json
{
  "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"
    }
  }
}
```

## Additional Sections and Examples

This document continues with various examples and structures, including data formats for risk matches, record details, and more, as outlined in the detailed specifications provided throughout.
