Custom API Action
Make a custom API call to the EvidentID Verify or Submit APIs.
Options
Field | Definition | Type | Required |
---|---|---|---|
API |
Use the appropriate API: |
Dropdown | TRUE |
Request Type |
Use the appropriate request type depending on the endpoint/method:
|
Dropdown | TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
User | |||
Relative URL |
Specify the relative URL as Example: {{buildCAPIAURL.output}}{{input.Request.Relative URL}} where buildCAPIAURL.output can be:
|
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:
|
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
-
In the API drop-down, select
Verify
. -
In the Request Type drop-down, select
POST
, then click Done.
The value in the Relative URL field must be /verify/requests
.
- 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
-
In the API drop-down, select
Verify
. -
In the Request Type drop-down, select
GET
, then click Done. -
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
-
In the API drop-down, select
Submit
. -
In the Request Type drop-down, select
POST
, then click Done. -
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.