Event codes¶

Preview

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

The key events that occurred when the real-time engine processed a job are available as event codes within the job's events property. Once a job completes, your application can read the event codes to programmatically interpret the outcome of each task and efficiently process the output.

Some job types perform more than one task, so there can be more than one event code available.

events is a read-only property.

Append LinkedIn URL¶

events.appendLinkedIn.code

This event code is available for the following job types:

enrichMobile Enrich Mobile & Verify Employment
verifyEmploymentHygiene Verify Employment (Hygiene)

Interpretation of the event codes:

"from_input": Your application provided the LinkedIn User URL. The URL is validated and used for other features.
"appended": Modigie successfully appended the LinkedIn User URL.
"replaced": Your application provided a LinkedIn User URL and Modigie replaced it with a URL that seems to be different.
"unable_to_append": Modigie could not append a LinkedIn User URL.

Verify Employment¶

events.verifyEmployment.code

This event code is available for the following job types:

enrichMobile Enrich Mobile & Verify Employment
verifyEmploymentHygiene Verify Employment (Hygiene)

Interpretation of the event codes:

"verified": The person works at the target company. This event typically also gives the current job title.
"changed": The person worked at the target company in the past, but either has left it or is about to leave it. This event typically includes the month the employment changed, the current employer, and the job title at the new company.
"unable_to_verify": Modigie was able to verify whether or not the person works at the target company or has worked there in the past. Although this event may include the current employer and job title, it may not be accurate.

Append mobile phone number¶

events.appendMobile.code

This event code is available for the following job types:

enrichMobile Enrich Mobile & Verify Employment

Interpretation of the event codes:

"appended": An active mobile phone number for this person has been appended to the output.
"unable_to_append": No mobile phone number has been appended.

Verify mobile phone number¶

events.verifyMobile.code

This event code is available for the following job types:

verifyMobile: For Verify Mobile your application provides one presumable mobile phone number of the given person. Modigie will enrich the number with intelligence signals and perform a rating.

Note

For every phone number provided by your application, Modigie will validate the syntax with any of the job types. The syntax validation signals are in the number's phoneNumber property and include indicators if a number is possible and valid, and multiple formats of the number for different use cases.

Interpretation of the event codes:

"good_mobile": Indicates that the verified phone number is a possible and valid phone number, an active mobile, and that it belongs to the given person.
"no_good_mobile": Indicates that the verified phone numbers is an active mobile number that belongs to the given person.
"unable_to_verify": Modigie was not able to rate the phone number provided by your application.

Example¶

Job requestJob response

Note

events is a read-only property.

The following is an example of an Enrich Mobile & Verify Employment job where Modigie appended the mobile phone number and the LinkedIn User URL and also verified that the person still works at the target company. events.verifyMobile is null because this is no task performed by this job type.

job-response.json

{
  "jobType": "enrichMobile",
  "events": {
    "appendLinkedIn": {
      "code": "appended"
    },
    "verifyEmployment": {
      "code": "verified"
    },
    "appendMobile": {
      "code": "appended"
    },
    "verifyMobile": null
  },
  ...
}

Schema: JobV2Events