API preview with synthetic test data

Preview

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

About the API preview

This API preview allows you to safely test different job result scenarios, the secure sending of job requests, and the secure receiving and processing of job responses. The preview uses the Enrich Mobile & Verify Employment job type (enrichMobile), as it is the most comprehensive, and the primary job type, both enriching the mobile number and verifying, updating the employer.

Please refer to Job Types to learn more about enrichMobile jobs and all other job types.

Preview configuration

Important

During this phase of the API preview, Modigie doesn't process jobs and does not store job data.

This configuration is designed to enable streamlined set up and testing of various scenarios and to ensure the proper functionality of the system in submitting requests and processing resultant data. The API preview allows you to safely test different job result scenarios, the secure sending of job requests, and the secure receiving and processing of job responses. The preview uses the Enrich Mobile & Verify Employment job type, as it is the most comprehensive, and the primary job type, both enriching the mobile number and verifying, updating the employer.

Job requests are published via a Cloud Pub/Sub topic provided by Modigie, consistent with the actual API's operational procedure. Your application will receive job responses through a Pub/Sub push or pull subscription based on your choice. This preview uses non-sensitive test data and provides synthetic job results, rather than engaging the real-time engine. While no Personally Identifiable Information (PII) data is expected to flow in either direction, testing the authentication with the provided service account is crucial. This is why the configuration in preview also requires your application to authenticate at Cloud Pub/Sub with the Application Account.

Job behavior in the preview

Specific input values control job result outcomes. For example, if the first letter of the first name in your job request is between A and M, a mobile number will be added to the job response. If it is between N and Z, no mobile number will be added. More details on controlling the job response are in the table below. This allows you to test all job events supported by the enrichMobile job type.

Any initial character outside the specified ranges for the first name, last name, or company name will be treated as an illegal input, and the job will be rejected. Your application will be able to publish the job request, as it passes the schema validation, but it will fail the advanced request validation, and your application will receive the rejected job with no changes in the payload.

The following features are different from the actual operational procedure:

• Cloud Pub/Sub will not perform schema validation when publishing a job request.
• Job request IDs are always treated as unique and never as duplicates.  In this preview we don’t store the job requests.
• Expiration and priority settings are not supported, and cancel requests are ignored.
• No quota control or usage tracking.

Deterministic outcomes

This configuration allows for streamlined testing of various scenarios and ensures your application functions correctly in submitting requests and processing resulting data.

Provided input values	Description	Event codes
First letter of first name between A and M	One mobile number gets appended	appendMobile="appended"
First letter of first name between N and Z	No mobile number gets appended	appendMobile="unable_to_append"
You provide a LinkedIn user URL and the first letter of last name between A and M	Provided LinkedIn will be used	appendLinkedIn="from_input"
You provide a LinkedIn user URL and the first letter of last name between N and Z	Provided LinkedIn URL gets replaced by an appended LinkedIn URL	appendLinkedIn="replaced"
No LinkedIn URL provided and first letter of last name between A and M	One LinkedIn URL gets appended	appendLinkedIn="appended"
No LinkedIn URL provided and first letter of last name between N and Z	No LinkedIn URL provided or appended	appendLinkedIn="unable_to_append"
First letter of company name between A and I	Prospect works at target company	verifyEmployment="verified"
First letter of company name between J and R	Prospect left target company	verifyEmployment="changed"
First letter of company name between S and Z	Unable to verify the current employment	verifyEmployment="unable_to_verify"
You provide a LinkedIn user URL that contains the word “email” anywhere in the path after /in/, e.g. https://www.linkedin.com/in/kelly-email-123	We append 1 email address	n/a
You provide a LinkedIn user URL that contains the word “location” anywhere in the path after /in/, e.g. https://www.linkedin.com/in/kelly-location	We append 1 location	n/a
You provide a LinkedIn user URL that contains the word “country” anywhere in the path after /in/, e.g. https://www.linkedin.com/in/kelly-country	We append 1 country	n/a
You provide a LinkedIn user URL that contains the word “address” anywhere in the path after /in/, e.g. https://www.linkedin.com/in/kelly-address	We append 1 address	n/a