Update a record | Parallel Developer Documentation

Version: Current – v2.x

This endpoint can be used to update a record for a business or individual.

HTTP Request

PUT https://api.parallelmarkets.com/v2/partner-records/{id}

{id} - The individual or business ID in your case management account. If an external_id has been set, the external_id value can be used instead.

Request Parameters

Individual Record
Business Record

Parameter	Description
`first_name` (string)	Optional. The first name of the individual.
`last_name` (string)	Optional. The last name of the individual.
`email` (string)	Optional. The email address for the individual.
`middle_name` (string)	Optional. The middle name of the individual.
`phone` (string)	Optional. The phone number for the individual in standard E.164 format with a country code prefix (i.e., "+12121234567").
`birth_date` (string)	Optional. String `YYYY-MM-DD` date representing the individual's date of birth.
`birth_place` (string)	Optional. The birth place of the individual.
`marital_status` (string)	Optional. The individual's marital status. Can be one of: - `single` - `married` - `separated` - `divorced`
`citizenship_country` (string)	Optional. ISO Alpha-2 Country Code representing the individual's country of citizenship.
`gender` (string)	Optional. The gender of the individual. Can be one of: - `male` - `female` - `other`
`name_suffix` (string)	Optional. The name suffix of the individual (e.g., "Jr.", "Sr.", "III").
`secondary_citizenship_countries` (string)	Optional. An array of ISO Alpha-2 Country Code country codes representing the individuals secondary countries of citizenship.
`tax_country` (string)	Optional. ISO Alpha-2 Country Code representing the individual's tax country.
`tax_id` (string)	Optional. The individual's provided tax id number (e.g. SSN).
`secondary_tax_ids` (array)	Optional. An array of objects, each containing the following keys: - `tax_country`: The secondary tax country of the individual, represented by an ISO Alpha-2 Country Code. - `tax_id`: The secondary tax id number of the individual.
`us_person` (boolean)	Optional. Indicates whether the individual is a U.S. person for federal tax purposes (includes but not limited to an individual U.S. citizen or U.S. resident alien).
`residence_location` (object)	Optional. A Location object representing the individual's residence address.
`domicile_location` (object)	Optional. A Location object representing the individual's legal address, where they pay taxes.
`external_id` (string)	Optional. A custom unique identifier for this record. See Using an External Identifier for more information.
`traits` (object[])	Optional. An array of objects representing trait values of the individual. See Updating Record Trait Values for more information.

Sample payload

{

"first_name": "John",

"last_name": "Smith",

"middle_name": "Roger",

"name_suffix": "Jr.",

"gender": "male",

"email": "jsmith@email.com",

"phone": "12125555555",

"birth_date": "1970-01-01",

"birth_place": "United States",

"marital_status": "single",

"citizenship_country": "US",

"secondary_citizenship_countries": ["CA"],

"tax_country": "US",

"tax_id": "123-45-6789",

"secondary_tax_ids": [
    {
      "tax_country": "CA",
      "tax_id": "000-999-000"
    }
  ],

"us_person": true,

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

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

"traits": [
    {
      "id": "commitment-amount",
      "value": "500000.25"
    },
    {
      "id": "external-ids",
      "value": ["us:12345-67890", "ca:12345-67890"]
    },
    {
      "id": "priority",
      "value": "Medium"
    },
    {
      "id": "refresh-date",
      "value": "2025-05-10"
    },
    {
      "id": "returning-investor",
      "value": true
    }
  ]
}

Parameter	Description
`name` (string)	Optional. The full, legal name of the business.
`business_type` (string)	Optional. The type of business. See Business Profile for possible values.
`incorporation_country` (string)	Optional. ISO Alpha-2 Country Code representing the business' country of incorporation.
`incorporation_region` (string)	Optional. The business's region of incorporation, if applicable. Required if `incorporation_country` is provided and outside of the United States.
`incorporation_state` (string)	Optional. String 2-letter state code; The business's state of incorporation. Required if `incorporation_country` is provided and is the United States.
`tax_country` (string)	Optional. ISO Alpha-2 Country Code representing the business's tax country.
`tax_id` (string)	Optional. The business's provided tax id number (e.g. EIN).
`secondary_tax_ids` (array)	Optional. An array of objects, each containing the following keys: - `tax_country`: The secondary tax country of the business, represented by an ISO Alpha-2 Country Code. - `tax_id`: The secondary tax id number of the business.
`us_person` (boolean)	Optional. Indicates whether the business is a U.S. person for federal tax purposes (includes but is not limited to a partnership, corporation, company or association created or organized in the United States or under the laws of the United States; any estate (other than a foreign estate); or a domestic trust).
`primary_contact` (object)	Optional. An object containing the following keys: - `id`: The ID of the individual record associated with the primary contact.
`control_persons` (array)	Optional. An array of objects containing the following keys: - `id`: The ID of the individual record associated with the control person. - `title`: The title of the control person. E.g. `CEO`.
`beneficial_owners` (array)	Optional. An array of objects containing the following keys: - `id`: The ID of the individual or business record associated with the beneficial owner. - `ownership_percent`: The fractional amount of direct ownership this entity has of the business (float number > 0.0 and ≤ 1.0). E.g. `0.25`.
`principal_location` (object)	Optional. A Location object representing where the business primarily conducts its business.
`domicile_location` (object)	Optional. A Location object representing the business's legal domicile.
`external_id` (string)	Optional. A custom unique identifier for this record. See Using an External Identifier for more information.
`traits` (object[])	Optional. An array of objects representing record trait values of the individual. See Updating Record Trait Values for more information.

{

"name": "Hooli LTD",

"business_type": "C Corporation",

"incorporation_country": "US",

"incorporation_state": "DE",

"tax_country": "US",

"tax_id": "12-3456789",

"secondary_tax_ids": [
    {
      "tax_country": "CA",
      "tax_id": "000-999-000"
    }
  ],

"us_person": true,

"primary_contact": {
    "id": "UG9kVXNlclJlY29yZDox"
  },

"control_persons": [
    {
      "id": "UG9kVXNlclJlY29yZDox",
      "title": "CEO"
    }
  ],

"beneficial_owners": [
    {
      "id": "UG9kVXNlclJlY29yZDox",
      "ownership_percent": 0.25
    }
  ],

"principal_location": {
    "address_one": "22 Wall St",
    "address_two": null,
    "city": "New York",
    "region": null,
    "postal_code": "10005",
    "state": "NY",
    "country": "US"
  },

"domicile_location": {
    "address_one": "22 Wall St",
    "address_two": null,
    "city": "New York",
    "region": null,
    "postal_code": "10005",
    "state": "NY",
    "country": "US"
  },

### Response Parameters  
Returns a [Record](https://developer.parallelmarkets.com/docs/server/data-structures#record) object for the updated record.

### Example Response  
- Individual Record
- Business Record

```json
{

"data": {

"id": "UG9kVXNlclJlY29yZDoxNzM=",

"type": "individual",

"created_at": "2023-09-01T09:57:23Z",

"details": {

"email": "jsmith@email.com",

"phone": "+12125555555",

"first_name": "John",

"middle_name": "Roger",

"last_name": "Smith",

"birth_date": "1970-01-01",

"birth_place": "United States",

"residence_location": {

"address_one": "123 Fake St",

"address_two": "Apt 3",

"city": "New York",

"region": null,

"postal_code": "10011",

"state": "NY",

"country": "US"

},

"domicile_location": {

"address_one": "123 Fake St",

"address_two": "Apt 3",

"city": "New York",

"region": null,

"postal_code": "10011",

"state": "NY",

"country": "US"

},

"marital_status": "single",

"citizenship_country": "US",

"secondary_citizenship_countries": ["CA"],

"tax_country": "US",

"tax_id": "123-45-6789",

"secondary_tax_ids": [
        {
          "tax_country": "CA",
          "tax_id": "000-999-000"
        }
      ],

"us_person": true,

"source": "api"

},

"traits": [
      {
        "id": "commitment-amount",
        "name": "Commitment Amount",
        "type": "number",
        "value": "500000.25"
      },
      {
        "id": "external-ids",
        "name": "External IDs",
        "type": "strings",
        "value": ["us:12345-67890", "ca:12345-67890"]
      },
      {
        "id": "priority",
        "name": "Priority",
        "type": "string",
        "value": "Medium"
      },
      {
        "id": "refresh-date",
        "name": "Refresh Date",
        "type": "date",
        "value": "2025-05-10"
      },
      {
        "id": "returning-investor",
        "name": "Returning Investor",
        "type": "boolean",
        "value": true
      }
    ],

"current_status": {

"status": "open",

"set_at": "2023-09-01T09:57:23Z"

}

}
}

{

"data": {

"id": "UG9kQnVzaW5lc3NSZWNvcmQ6MTQ5",

"type": "business",

"created_at": "2023-09-01T09:57:23Z",

"details": {

"name": "Hooli Ltd",

"tax_country": "US",

"tax_id": "12-3456789",

"secondary_tax_ids": [
        {
          "tax_country": "CA",
          "tax_id": "000-999-000"
        }
      ],

"us_person": true,

"principal_location": {

"address_one": "22 Wall St",

"address_two": null,

"city": "New York",

"region": null,

"postal_code": "10005",

"state": "NY",

"country": "US"

},

"business_type": "C Corporation",

"primary_contact": {

"id": ""

},

"control_persons": [],

"beneficial_owners": []

},

"current_status": {

"status": "open",

"set_at": "2023-09-01T09:59:10Z"

}

}
}