Skip to main content

Register Defender application

Process Flow​

Informed Defender follows the same flow as the Informed Consumer flow for registering applications and uploading associated files with the intent of receiving asynchronous callbacks containing Defender analysis.

Base URL​

The table below shows the Base URL to be used with the endpoints mentioned in this guide.

EnvironmentBase URL
Staging:https://api.staging.informediq-infra.com
Production:https://api.informediq.com

Example Request​

The first step is to register the application and associated applicant with Informed. The below code block shows an example request payload for the initial call to register an application. The following sections provide details on the key nodes of the request payload.

Full Example Application
{
  "application_reference_id": "your_unique_application_id",
  "application_date": "2021-05-09T09:11:38",
  "application_type": "Application",
  "application_status": "active",
  "applicants": {
    "applicant1": {
      "first_name": "Jo",
      "middle_name": null,
      "last_name": "Boren",
      "suffix": null,
      "email": "jo.boren@gmail.com",
      "phone": "9196201234",
      "ssn": "681129638",
      "date_of_birth": "1965-12-10",
      "address_info": [
        {
          "address": {
            "street_address": "8717 S 4th Ave",
            "city": "Inglewood",
            "state": "CA",
            "zip": "90305"
          },
          "is_current": true,
          "start_date": "2020-10-01",
          "end_date": null,
          "residence_type": "Rent",
          "monthly_housing_cost": 1000
        }
      ],
      "employment_info": [
        {
          "employment_type": "Employed",
          "employer_name": "Envoy Air, Inc.",
          "is_current": true,
          "occupation": "Crew Member",
          "income": {
            "period": "Yearly",
            "amount": 74500
          },
          "start_date": "2018-11-01",
          "end_date": null,
          "business_phone": "9196571475"
        }
      ],
      "additional_incomes": [
        {
          "source": "ChildSupport",
          "income": {
            "period": "Yearly",
            "amount": 10000
          }
        }
      ]
    }
  },
  "verifications": {},
  "services": [
    "extract",
    "verify"
  ],
  "webhook": "https://your.callback.com/here"
}
tip

Note that the verifications property has an empty object for its value. This is because the single Defender misrepresentation verification will be automatically processed when Defender is enabled for your workflow.

While it is always beneficial in the long run to provide as much information as possible in your application registration, you may have a use case in which you do not have all of the information shown in the example above. The below snippet of JSON shows the minimum payload that can be used to register a Defender application.

caution

Please note that this payload should only be used if you are solely using the Defender service.

Minimum Defender registration payload​

{
  "application_reference_id": "your-unique-app-id",
  "application_date": "2021-04-17T23:37:36",
  "application_type": "Application",
  "application_status": "active",
  "applicants": {
    "applicant1": {}
  },
  "verifications": {},
  "services": [
    "verify"
  ],
  "webhook": "https://your.endpoint.com",
  "application_options": {
    "auto_register_from_doc": true
  }
}

Request Components​

For the endpoint, application-level and applicant-level registration information, the Defender service follows the Informed Consumer documentation.

Verifications​

tip

The verifications object will be left empty if you are solely using Defender.

{
  ...
  "verifications": {}
  ...
}

Services​

Because Defender is a verification-based service, the only applicable services to include in your request are the extract and verify services. The verify service is required, but note that the extract service is purely optional.

{
  ...
  "services": [
    "extract",  // optional
    "verify"
  ],
  ...
}

Callback Url​

A webhook must be provided to receive the asynchronous responses containing classified documents with extracted data and analysis. Authentication details will need to be shared with Informed to ensure secure transmission at time of setup. To further safeguard data, Informed will only POST back to your webhook using the HTTPS protocol to ensure encryption in transit. More technical details about your callback endpoint can be found at the link in this paragraph above.

caution

Please note that you are not forced to provide a webhook URL. If you send an empty string for the value of the webhook property, you will not receive any asynchronous, programmatic callbacks with data.

{
  ...
  "webhook": "https://your.callback.com/here"
}

Synchronous Response​

A successful API request resulting in an application registration will return the following synchronous response to indicate that the application was submitted to Informed. Make sure that you record the application_id value, as you will need that in subsequent steps, such as associating documents with the application or updating the applicant info.


  {
    "application_id": "unique-Informed-app-id",
    "status": "Ready"
  }

Updating Application Info​

The update payload will look the same as the initial application registration request payload, but with the modified values/additions. And, you will need to send this as a PUT call to a slightly different endpoint because the application already exists.

caution

Note that this is a PUT and not a PATCH call, which means that you must resend the entire original payload but with any applicable modifications.

The one thing you cannot update with this PUT call for an existing application is the application_reference_id. That value must stay the same for the life of the application.

You will append the following endpoint to the base URL to update the application:

/v1/consumer/applications/<unique-Informed-app-id>

So to put it all together, you will make a PUT call to the following URL with your request payload:

https://api.staging.informediq-infra.com/v1/consumer/applications/<unique-Informed-app-id>

tip

The synchronous response will contain the same unique-Informed-app-id that you received in the synchronous response to the original application registration.


  {
    "application_id": "unique-Informed-app-id",
    "status": "Ready"
  }