Overview

The MetaMap API allows you to integrate your customized verification flows for your users through a series of REST requests.

Product Types

There are two main types of products available via API:

Endpoint summary

Product Type

Endpoints

Merits

/v2/verifications
/v2/identities
/media/

Standalone checks

/safety/v1/checks/
/govchecks/v1/

MetaMap builder products

MetaMap builder products allow you to make use of Metamap's prebuilt user experience and business rules. You need to configure a metamap and get the metamap ID from the dashboard to reference in your calls.

Requirements

  • Create your metamap in the Dashboard
  • Set up your servers to receive verification events from our products using webhooks
  • MetaMap's API requests require SSL installed on your server to securely transfer data.

Workflow

MetaMap's API for user verification using our metamaps requires a sequence of API requests.

1. Authenticationhttps://api.getmati.com/oauth
This API request replies with a JSON, containing the account’s information, and most importantly the JWT Token which you can use for 1 hour (3600 seconds) before needing to send a new Authentication request.

2. Verification Creationhttps://api.getmati.com/v2/verifications
Use the JWT Token obtained through the Authentication request to specify which Experience you are using. The metamap determines what data you need to send, as well as a custom metadata JSON object with key-value pairs as needed. This endpoint replies with the Identity Instance information such as the expected inputs, metamap ID, and metamap information so you can double-check that you are making the correct invocation.

3. Send User Identifiershttps://api.getmati.com/v2/identities/{{identity}}/send-input
Use the JWT Token obtained through the authentication step and the metamap ID value received on the previous request (Verification Creation) to receive the user’s input (documents, images, and/or videos) as well as a description in JSON format of the inputs being sent through the request.

MetaMap will then process the sent information and the partial and total results to your backend through Webhooks. You need to set up a Webhook listener on your server and configure the endpoint of that listener on your MetaMap Dashboard. Each Webhook will include your custom metadata object, so you can match the users and processes 1:1.

Standalone Checks

Standalone checks are separate verification checks that you can use without setting up a metamap. The following products are available as a standalone check:

  • Email validation
  • Comply Advantage checks
  • Government Checks

Authentication

The MetaMap API uses a Client ID to authenticate requests. You can find your Client ID and Client Secret from the Dashboard under the "For Developers" tab.


Did this page help you?