Custom API Action

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

This card only supports production APIs. Sandbox APIs (also referred to as demo APIs) aren't supported.

Options

Field Definition Type Required

API

Select the appropriate API to query: 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. Exercise caution to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.

  • PUT: Sends the data you want to store 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 isn't 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

The URL address of the web server that you're attempting to call. Specify the relative URL as /{insert_remaining_URL}.

You can specify query parameters in the relative URL using ?, or specify the query parameters as a key and value pair in the Query input.

For example, for the Evident ID API endpoints:

  • Verify Production:

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

  • Submit Production:

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

See Evident ID API documentation.

 Text TRUE

Query

Specify any additional query parameters that should be included as key and value pairs.

For example, {"name":"something-urgent"}.

 Object FALSE

Headers

Specify any headers required in addition to authorization or content-type, as the connector already handles those headers.

 Object FALSE

Body

Specify a request body in JSON format.

This input is only available for POST, PUT, and PATCH requests.

 Object FALSE

Output

Field Definition Type

Response

Status Code

(Undefined variable: workflows_fields.output-status-code)

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 dropdown menu, select Verify.

  2. In the Request Type dropdown menu, select POST, then click Save.

  3. Select all the request inputs, and 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 dropdown menu, select Verify.

  2. In the Request Type dropdown menu, select GET, and then click Save.

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

This step enables you to obtain the user's bearer token and the ID of the request. The bearer token allows you to call the Submit API to submit data.

Call Submit API to Submit Data

  1. In the API dropdown menu, select Submit.

  2. In the Request Type dropdown menu, select POST, and then click Save.

  3. In the Body field, add an input, for example:

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.