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 (drop-down): 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 your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content.

  • POST - sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message.

  • PUT - sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message.

  • PATCH - applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message.

  • DELETE - deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message.

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:

    • VerifyProduction: https://verify.api.evidentid.com/api/v1
    • SubmitProduction: https://submit.api.evidentid.com/api/v1
    • VerifyDemo: https://verify.api.demo.evidentid.com/api/v1
    • 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): The result of your HTTP request. See HTTP 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 be usually similar to {"Content-type":"application/json"}.
  • Body(object): The 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 eyJhbGciOiJSUzI1NiJ9.eyJub25jZSI6IlJxYWE2SEdNWEpLYnJGWmE4dkg1TldVVmlyUjBjcktuIiwiYXVkIjoib2t0YS5ibGluZHRydXN0LnRoaXJkcGFydHkuaWRvd25lci5ldmlkZW50aWQuY29tIiwiZXhwIjoxNTgwMTgwODA4LCJpc3MiOiIvQz1VUy9TVD1HZW9yZ2lhL0w9QWxwaGFyZXR0YS9PPUV2aWRlbnRJRC1EZXZlbG9wbWVudC9PVT1yZWx5aW5ncGFydHkvQ049b2t0YS9lbWFpbEFkZHJlc3M9c3VwcG9ydEBva3RhLmNvbSIsImlhdCI6MTU3ODk3MTIwOCwiZW1haWwiOiJkYXZpZC5yb29zc2llbkBnbWFpbC5jb20iLCJyZXF1ZXN0SWQiOiIxMWViZDYxZS05NjJhLTQxMWItYjJmMi1iZDg1ZjZiNGNkMWMiLCJzdWIiOiIxNWQ0ZDZiMGVhMzk3ZmE5NzhlNTgzZmFhYzc5MjAzMTY4MTc1ZWYzNDRiZGY4YzBiZTNhZTFlOWZhNGQ1YmRhQG9rdGEuYmxpbmR0cnVzdC50aGlyZHBhcnR5Lmlkb3duZXIuZXZpZGVudGlkLmNvbSJ9.mhq3R4zJNXZziGt9X1_iEMp0FKpq54lf7ldkTm9kiwkt6YVsSV4R3K-SgJBe82KO47_QwZj-COqlgsaU66N5-6nlfHQOaRjVGN6P1NrB94dpZ1EA2LgIDUSR2QYKscga-pS8FMrEXbrckucrIZaPhf5sjM1gm-spyd92BY9gDaJuRfKi2oJh6An-IBJUqALxd3k3UNEYv2I9pAuyWEdmnroCJmQFA9mPol3ae-PAFID-EFzVX7htgjbV0RwneIDXzH1dCT22ha1Wc8SvRDbh8OkVacMaODiMIpwbNtcmKDd4Tj0veb2zgA3QM29MmXXJX7rCcP-V3dgVTpRe3-IZYvxtxHEZ1y5EdMyRjtqO1LFAzykI88hpeY6QxKT8cOMzR7Uuj75lYorW3O8oZQmqciYYQrAF28eAka8no4ULDR2gIyN79WmZwwqSIa40kcc597bPYui4D0nXRZj9nrDqe1yVo2WHK1etO1D5Qj61GcaaRUc0Xt1tFDyp2Z_KAHGKu4mW2S3KC8Zp1xj2k2WFnTE_W1Xq6Sas1djWOve4nDXUpCRsd632qw4QOgbJSB9QVZCxXLs50ic9sjYiF5WzZcQFPBgYuZ7ryxALGPzTpP-WS0PXLG7Sat6Lax0NtNVWVojAZ9ANQlfDFv54A9CJx9HRklEAGobWNGKlStjsuxs"

},

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

See Also

Connectors

About the elements of Okta Workflows

Evident ID API documentation