Skip to content

Onboarding process

Once you have completed the data diagnostic on a sample batch and the business requirement analysis with our team, you should have a clear understanding of:

  • The possible contribution of our different Job types to your business needs.
  • The coverage and accuracy that your business can expect from our real-time engine in production.
  • The use cases where you want to embed the Modigie Integration for Cloud Pub/Sub API.
  • For each use case and job type, the tolerable turn around time (from request to completed response), expected monthly usage and maximum bursts during a month.
  • The technology stack that you will use to integrate with the API, mainly the programming language, hosting provider and platform or products that will run your application.

To programmatically access our real-time engine through a RESTful API, your application needs an exclusive Modigie Pub/Sub Repository. This is an instance of our Modigie Integration for Cloud Pub/Sub API that manages all configurations, jobs, and other data for your application. Modigie will provide you with multiple repositories during the onboarding and all related resources on our side.

The onboarding process consists of three main phases:

  1. If you are a new customer or partner, we will provide you with a new Modigie Org Account that will contain all your Modigie resources in our system.
  2. You will get a synthetic Pub/Sub Repository, which is designed for discovery and integration tests with your non-production system. You can use it to:
    1. Interactively explore the request and response schemas for the job types you want to use.
    2. Design and implement a PoC and use the synthetic job requests to cover all possible scenarios, including failures.
    3. Confirm that your application logic works robust on scale and meets your business needs.
  3. You will get a regular Pub/Sub repository to run real jobs with your application in production. You will need to replace the credentials and configurations.

Note

Please note that a synthetic repository can't be used to run real jobs. It is designed for testing your application logic during implementation. See Synthetic Repository for more information.

Requesting access

  1. Choose the job types that meet your business needs.
  2. Inform Modigie which job types you would like to test.
  3. Based on your technical requirements, choose one or both of the subscription modes. Every job type gets a separate pull and/or push subscription.
  4. By default, we will provide you with a pull subscription where job responses can be pulled programmatically and which you can also pull interactively to debug manually. If you don't want a pull subscription for a job type, please opt out.
  5. If you want the job responses to be delivered via a push subscription, please provide us with the endpoint URL for each job type (however, you can use the same URL if you prefer).
  6. Send Modigie a list of the Google Cloud user accounts that will get the Cloud IAM permissions to create and rotate the private keys of the Application Account.

Example

Job types and subscriptions, one of push | pull | both:

  1. Enrich Mobile & Verify Employment - enrichMobile: pull
  2. Verify Employment - verifyEmployment: pull
  3. Verify Mobile - verifyMobile: push to URL https://www.example.com/callbacks/v2?job_type=verifyMobile

Confirmation from Modigie

Based on your request, Modigie will provide you with:

  1. The ID of your Modigie Org Account
  2. The ID of your Modigie Pub/Sub Repository and whether it is synthetic or real
  3. The full names of every Pub/Sub topic for job requests (one per job type)
  4. The full names of every Pub/Sub pull subscription for job responses (one per job type)
  5. The full names of every Pub/Sub push subscription for job responses (one per job type) and the endpoint URL to where it will send the callbacks
  6. The Application Account's service account email address for verifying the authenticity of pushed messages
  7. Your requested Google Cloud users will have access to the Application Account
  8. The current Job dispatch rate of every job type based on your expected monthly usage. Please refer to Quotas and limitations for more information.

The configuration will be shared with you as a PDF whenever it changes.

Configure your application

Configure your custom application, e.g. with environment variables so it has these values available when needed:

  1. The Google Cloud project ID that hosts all GCP resources that Modigie created for you (it's always the same project for an Org Account).
  2. One of your Google Cloud users visits the GCP Console to create and download a private key JSON file for the Application Account and transfers these credentials into a secure storage of your application.
  3. The Application Account's service account email address for verifying the authenticity of pushed messages
  4. For every job type:
    • the name of the Pub/Sub topic to publish job requests of this job type
    • the name of the Pub/Sub pull subscription to pull job responses of this job type