Parallel Developer Documentation Legacy – v1.x

This is documentation for Parallel Developer Documentation Legacy – v1.x, which is no longer actively maintained.

For up-to-date documentation, see the latest version (Current – v2.x).

Sandbox Access

This guide is applicable to partners that have a sandbox account set up. If you do not have a sandbox account, please reach out to your Parallel Markets sales representative or send a request to our sales team here.

The sandbox environment is designed to help partners test the Parallel Markets integration, including client-side SDKs, server-side APIs, and webhooks. This guide aims to help you get up and running as quickly as possible, as well as outlining some sandbox-specific behaviour to be aware of.

Before we begin

1. The sandbox environment is purely a test environment. No actual accreditation checks are performed nor is identity / business information vetted, hence, no real documents should be uploaded.
2. For partners with production access, any records created in the production environment are billable. Therefore, all testing should be done against the sandbox environment.

Step 1: Prepare your environment

Before any integration can be done on the client or server-side, an OAuth client must be configured within the dashboard. Ensure you are logging into the sandbox dashboard at https://demo.parallelmarkets.com.

Checkpoint: OAuth Client Created

Once you have created an OAuth client, the associated client_id and client_secret will be used for the client and server-side integration.

Step 2: Client-side integration

You can integrate our Javascript SDK on the client-side to begin testing your integration.

To indicate that you'd like to use the demo environment for sandbox testing, just use the environment configuration variable with a value of demo.

Parallel.init({ client_id: 'your_client_id', environment: 'demo' })

Demo Environment Configuration

Don't forget to set the environment configuration variable to demo. Without this, your integration will attempt to communicate with our production environment, which will not work.

Checkpoint: Test the end user experience

Once you have integrated the SDK you will be able to test the end user experience by clicking on the Parallel Passport button to initiate the flow. Submitted records can be viewed in the dashboard, or optionally, queried via the API.

Step 3: Server-side integration (Optional)

If you require programmatic access to individual and business records from your systems, you can now integrate with our Case Management API.

Note:

Ensure that you are integrating with our sandbox endpoints listed below. Sandbox API endpoints will begin with https://demo-api.parallelmarkets.com....

Endpoints

Demo Environment Configuration

Ensure you are using the Sandbox endpoints listed above. Using the production API endpoints with an API key associated with a sandbox account will fail.

Checkpoint: Test API calls

You should now be able to test making API calls to the sandbox API endpoints using an API key.

Step 4: Handle webhooks (Optional)

When identity or accreditation information is updated within Parallel Markets, these event notifications can be pushed to your server using webhooks. This is a good way to listen to event updates, after which you can query the API to obtain specific information regarding the updated data.

Step 5: Test different outcomes

The sandbox environment supports triggering a various outcomes for identity and accreditation flows for testing purposes. These options are outlined below.

Identity

By default, no sanctions matches will be found for any submissions made in the sandbox environment. If you would like to test the behaviour of a sanctions match, this can be triggered by including the word sanction in an individual's last name or a business' name when going through the identity flow. This will result in a sanctions match that will be available in the dashboard, as well as trigger the relevant identity scope webhooks.

Accreditation

1. All new accreditation applications for individuals with a minus sign at the end of their last name (i.e. John Doe-) will get automatically rejected within 10 minutes of submission.
2. All new accreditation applications for businesses with a minus sign at the end of their name (i.e. A Company Inc.-) will get automatically rejected within 10 minutes of submission.
3. All new accreditation applications for individuals with a plus sign at the end of their last name (i.e. John Doe+) will get automatically certified within 10 minutes of submission.
4. All new accreditation applications for businesses with a plus sign at the end of their name (i.e. A Company Inc.+) will get automatically certified within 10 minutes of submission.

Evaluator Type Applications

Note that user and business applications that are created with a request to an evaluator (outside CPA / lawyer / etc) will not be automatically certified unless the evaluator account provides documentation first. If you'd like to test with these application types, make sure to input evaluator contact info for an account you already have access to (make sure to create the account first).

Troubleshooting

The most common issue when attempting to integrate with the sandbox environment is inadvertently integrating with the production environment. Please ensure you are setting the environment: "demo" configuration option in the client-side SDK, and calling the sandbox API with the demo-api subdomain ( https://demo-api.parallelmarkets.com/...).

If you run into further issues, please reach out to the Partner Integrations Team with details about your issue, including:

1. Description of the behavior you are experiencing.
2. Description of the expected behavior.
3. Screenshots or screen recordings demonstrating the behavior.