Skip to content

Documentation for Modigie Integration for Cloud Pub/Sub API

JobV2 resource

Request

The request schema of all job types varies only in which properties are required.

Response

The response schema of any job type is the same, although the presence of certain properties depends on the job type.

Rich attributes

Modigie's JobV2 utilizes the concept of rich attributes for some important information. Rich attributes have two layers:

  • The inner layer composes the syntax components of an attribute and is relevant for advanced validation (e.g., determining if a given value is valid). It typically contains the value in different formats for a variety of use cases.
  • The outer layer composes the intelligence components of an attribute and is relevant for the verification, which provides contextualized intelligence, e.g. if a phone number is mobile, recently active and is assigned to the given person.

JobV2 supports three different types of rich attributes.

Phone number

Request:

payload.phoneNumbers can be provided to all job types for an advanced validation, but some job types require phone numbers for verification.

  • ItuPhoneV2Request is the syntax component only that is included in RichPhoneV2Request.
  • RichPhoneV2Request is a rich attribute includes intelligence and the syntax component of a phone number
Response:

payload.phoneNumbers may contain phone numbers that you have provided for validation or verification. For enrichment jobs, it may also contain phone numbers appended by Modigie.

  • ItuPhoneV2 is the syntax component only that is included in RichPhoneV2.
  • RichPhoneV2 is a rich attribute that includes intelligence and the syntax component of a phone number.

URLs

Typically a LinkedIn user profile.

Request:

payload.urls can be provided to all job types for an advanced validation, but some job types may require a certain URL for verification or enrichment.

  • UrlV2 is the syntax component only that is included in RichUrlV2Request.
  • RichUrlV2Request is a rich attribute that includes intelligence and the syntax component of a URL
Response:

payload.urls may contain URLs that you have provided for validation or verification. For enrichment jobs, it may also contain a person's LinkedIn profile appended by Modigie.

  • UrlV2 is the syntax component only that is included in RichUrlV2.
  • `RichUrlV2 is a rich attribute that includes intelligence and the syntax component of a URL.

Email address

Request

payload.emailAddresses can be provided to all job types for an advanced validation, but some job types may require a personal business or private email address for verification or enrichment.

Response

payload.emailAddresses may contain email addresses that you have provided for validation or verification. For enrichment jobs, it may also contain a person's business email address appended by Modigie.

  • EmailAddress is the syntax component only that is included in RichEmailAddressV2.
  • RichEmailAddressV2 is a rich attribute that includes intelligence and the syntax component of an email address.

Other attributes

Country

Request:

As country property for phone numbers or addresses in a job request.

Important

You CANNOT use CountryV2Request to provide payload.countries in a job request as it is a read-only property.

Response:

As part of phone number validation or payload.countries in a job response.

Location

Request:
payload.locations is a read-only property.
Response:

For some job types we provide payload.locations in a job response.