Custom API Action

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

Note

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

Use the appropriate request type depending on the endpoint/method:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
Dropdown TRUE

Input

Field Definition Type Required
User
Relative URL

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.

Example:

{{buildCAPIAURL.output}}{{input.Request.Relative URL}}

where buildCAPIAURL.output can be:

  1. VerifyProduction: "https://verify.api.evidentid.com/api/v1"
  2. SubmitProduction: "https://submit.api.evidentid.com/api/v1"
String FALSE
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 Success or failure of your HTTP request; here is a list of all status codes Number
Headers

Detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will usually be a replica of the following:

{"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:

{

    "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:

{

    "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

About the elements of Okta Workflows

Evident ID API documentation