Custom API Action

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

Options

  • API (dropdown): use the appropriate API

    • Verify

    • Submit

  • Request Type (dropdown): use the appropriate request type depending on the endpoint/method

    • GET

    • POST

    • PUT

    • PATCH

    • DELETE

Input

  • Relative URL (text): 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"

3.  VerifyDemo: "https://verify.api.demo.evidentid.com/api/v1"

4.  SubmitDemo: "https://submit.api.demo.evidentid.com/api/v1"

  • Query (object): Specify any additional query parameters that should be included in object format (key value pairs).

  • Headers (object): Specify any headers required in addition to authorization or content-type (these are already handled by this connector).

  • Body (object): Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests.

Output

Response

  • Status Code (number): success or failure of your HTTP request. Here is a list of all status codes.

  • Headers (object): a 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 example below.

    Example: {"Content-type":"application/json"}

  • Body (object): data returned from your selected HTTP request (for example, the data from a GET request).

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 Done.

The value in the Relative URL field must be /verify/requests.

  1. In the Body field, add an input. In this example, the input is data for a driver's license:

{

"description": "Upload license",

"email": "output@atko.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 Done.

  3. In the 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 reqeust. 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 Done.

  3. In the Body field, add an input. This 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.