Skip to content

Onboarding process

Preview

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

Requesting access

In order to access the API preview, you can request your own instance in our preview environment. We will provide you with a Modigie Org Account and a Modigie Pub/Sub Repository.

Important

At this point of the API preview we only provision synthetic repositories for testing.

  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

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