Skip to content

Person object

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

The person for whom your application requests the job. This represents a B2B contact.

Schema

The job's payload.person property is of type JobV2Person.

A JobV2Person object has four properties, as described below:

firstName: string
The full first name, or given name, whenever possible. Abbreviations or initials might reduce accuracy. Single-letter names are accepted, as they are valid in some cultures (for example, the Korean name or the Japanese name are romanized as the Latin letter O). In the U.S., single-letter names like J or J. are also possible. Example: "Jane"
middleNames: string optional
Middle names are optional; initials are acceptable. Including middle names can improve accuracy, especially for common name combinations. Example: "E."
lastName: string
The full last name, or family name or surname. Example: "Smith"
source: JobV2Source optional
The source of this Person object. See Source of an attribute for more details.

Example

job-request.json
{
  "payload": {
    "person": {
      "firstName": "John",
      "middleNames": null,
      "lastName": "Doe",
      "source": {
        ...
      }
    },
    ...
  },
  ...
}

Modigie will not modify the properties of a Person.

job-response.json
{
  "payload": {
    "person": {
      "firstName": "John",
      "middleNames": null,
      "lastName": "Doe",
      "source": {
        ...
      }
    },
    ...
  },
  ...
}

Schema: JobV2Person