GoAver.com API Integration

GoAver.com uses permissioned API keys and Basic Authentication over HTTPS to allow easy access to API features

Example Code

Example code / projects can be found here:
https://github.com/goaver/api-integration/tree/master/examples

Accessing the API

First, create your API key in your organization's GoAver.com account:

1. Navigate to Settings -> API Keys
2. Add an API key
3. Copy the "secret"

4. View the key that was created and copy the "key"

5. Find the group id of the group you want to create checks under

Create your Basic Authentication Header for your Request

Details on Basic Authentication can be found here:
https://en.wikipedia.org/wiki/Basic_access_authentication (see Client Side)

1. Concatenate < key >:< secret >
2. Base64 encode the concatenated values
3. Include the Base64 encoded value in the Authorization header for Basic auth

Call the Auth API Endpoint

Call the API auth endpoint with your basic authentication header to return a JWT token so you can call other API endpoints and take further action.

https://app.goaver.com/api/auth/token

Use Case: Example Create Check

The most common use case is to make a request to create a check for the user on the behalf of your organization if you choose not to invite them via the portal or require deeper integration for higher volume workflows.

Steps

• Get your auth token as outlined above and set it as the bearer token in the authorization header
• Set the content-type header to "application/json"
• Set the check request create parameters in the body of your request
• POST to https://goaver.com/api/check/create

Request parameters

thirdPartyIdentifier (required) - A unique identifier for this create request to ensure idempotentcy and prevent multiple checks being created on your behalf. This could be a user account number or unique identifier within your existing application or randomly generated.

groupId (required) - The check group context you want this check to be created under. (For details on managing your check groups, please see the GoAver.com product documentation)

email (required) - The e-mail address of the user the check is being created for that will be used to send access links to the user if necessary.

language (optional) - The default language to use for the check enrollment for the user (they can change the language during enrollment). Options are "en"(English), "zh-Hans"(Chinese), and "fr"(French). Default is English if this is not provided.

returnUrl (optional) - The url to redirect to for the user once they have completed the check enrollment workflow. This is generally used for inline workflows. The status / complete page will be shown at the end of enrollment if this is not set.

Example Request Header

content-type: application/json
authorization: Bearer ZiA5MGQyMDMtYWM2NS00NzI5LTg5ZGItYTc5YWY4ZGQyZTUzOk9EYzVNREcxWWpAMk5qQmtPR0UyT2zNMU5EZGhNVGhpWW1WaVlUYzROVEE1T1dNNVpqSTROemN3T0RVPQ==

Example Request Body

{
  "thirdPartyIdentifier":"12345",
  "groupId":"0aa4f4b8-c32f-4581-942d-559727582562",
  "returnUrl":"https://www.yoursite.com/checkcomplete",
  "language":"en",
  "email":"someuser@user.com"
}

2. Get the Check Create Response

If your POST is successful you will get the check create response containing the created check parameters:

{
  "checkId":"0aa4f4b8-c32f-4581-942d-5597272523562",
  "thirdPartyIdentifier":"12345",
  "url":"https://app.goaver.com/checkenrollment/0aa4f4b8-c32f-4581-942d-5597272523562?accessCode=5ZGItYTc5YWY4ZGQyZTUzOk9EYzVNREcxWWpAMk5qQmtPR0UyT2&language=en&returnUrl=https://www.yoursite.com/checkcomplete
}

Response parameters

checkId - The unique identifier of the check

thirdPartyIdentifier - The third party identifier for the created check (provided above)

url - The link url to be passed to the user to allow them to access this created enrollment and continue the process

3. Redirect the Client Browser to Begin the Check Enrollment Workflow

Redirect the user to the url you retrieved in the previous step.

This will begin the process for the user and to send them through the verification workflow, returning them to the url specified in returlUrl at the end of the workflow if it was provided.