Custom API Action

Make a custom API call to the Evident ID Verify or Submit APIs.

Only production APIs are supported. Sandbox APIs, also referred to as demo APIs, are not supported.

Options

Field Definition Type Required
API Use the appropriate API: Verify or Submit Dropdown TRUE
Request Type This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).
  • GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content.
  • POST: Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.
  • PUT: Sends data to be stored at a specific location on a web server based on parameters (for example, uploading a file). Unlike POST requests, PUT requests are idempotent. For successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, a 200 (OK), 201 (Created), or 204 (No Content) response message is returned.
  • PATCH: Applies partial modifications to a resource on a web server based on parameters. PATCH is not idempotent. Multiple PATCH requests could have unintended consequences. If a PATCH is successful, a 200 (OK) or 204 (No Content) response message is returned.
  • DELETE: Deletes the specified resource (if it exists) from the web server based on parameters. If a DELETE is successful, a 200 (OK) response message is returned.
Dropdown TRUE

Input

Field Definition Type Required
User
Relative URL URL address on the web server to which you are attempting to interact. Specify the relative URL as /{insert_remaining_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input.

For example, for Evident ID API endpoints:

VerifyProduction:

https://verify.api.evidentid.com/api/v1/verify/requestTemplates the relative URL is: /verify/requestTemplates.

SubmitProduction:
https://submit.api.evidentid.com/api/v1/requests the relative URL is: /requests.

See Evident ID API documentation.

 String TRUE
Query Specify any additional query parameters that should be included in object format (key value pairs) Object FALSE
Headers Specify any headers required in addition to authorization or content-type (these are already handled by this connector) Object FALSE
Body Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests. Object FALSE

Output

Field Definition Type
Response
Status Code Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:
  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

 Number
Headers Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. This is similar to {"Content-type":"application/json"}. Object
Body Data returned from your selected HTTP request.

For example, the data from a GET request.

 Object

Call Verify API to Create a New Request

  1. In the API drop-down, select Verify.

  2. In the Request Type drop-down, select POST, then click Save.

  3. Select all of the request inputs, then click Save.

  4. Enter /verify/requests in the Relative URL field.

  5. Enter the request in the Body field. For example, the following input requests data for a driver's license:

Copy 
{
    "description": "Upload license",
    "email": "output@example.com",
    "attributesRequested": 
    [
        {"attributeType": "core.firstname"},
        {"attributeType": "core.lastname"},
        {"attributeType": "core.address.fulladdress"},
        {"attributeType": "identity_assurance.document_verification.americas.us.verification_status"}
    ]
}

The API returns a Body that contains an id. Use that id in the next request.

Get the userIdentityToken

  1. In the API drop-down, select Verify.

  2. In the Request Type drop-down, select GET, then click Save.

  3. In the Relative URL field, enter a value similar to /verify/requests/{id}/authToken.

This step will allow you to obtain the user's bearer token and the id of the request. The bearer token will allow you to call the Submit API to submit data.

Call Submit API to Submit Data

  1. In the API drop-down, select Submit.

  2. In the Request Type drop-down, select POST, then click Save.

  3. In the Body field, add an input. The following is a sample:

Copy 
{
    "Request:": 
    {
        "Relative URL": "/requests",
        "metadata": "getHttpInputs",
        "config": "",
        "Headers": 
        {
            "Accept": "application/json",
            "Content-Type": "application/json",
            "Authorization": "Bearer <bearer token obfuscated>"
        },
        "Body": 
        {
            "inputs": 
            [
                    {
                        "type": "core.firstname",
                        "value": "Workflows"
                    },
                    {
                        "type": "core.lastname",
                        "value": "Test"
                    },
                    {
                        "type": "certifications.servsafe.servsafe_food_handler.certnumber",
                        "value": "1234567"
                    }
                ]
                }
            }
}

Note the values for the Relative URL and Headers fields.

The Submit API allows you to submit data using the user's bearer token from the previous step.

Related topics

Evident ID connector

Workflow elements

Evident ID API documentation