API Documentation

Verifier API: Provisioning Verifiers

By using our Verifier (REST) API, companies and individuals have the ability to add or remove additional verifiers at the company, region, or branch level.

  1. Proper Permissions
  2. Adding a Verifier
  3. Deleting a Verifier

Proper Permissions

All API calls made using REST require the use of Basic Auth, thus requiring an individual to be set-up at the company level. When an individual is set-up to use our Verifier API, they are assigned one of the following roles:

AccountChek Company Role View/Edit Privileges
CorporateAdmin May view and edit all orders in your Company. Can also add/remove/edit Company users for all roles listed below.
Operations May view and edit all orders in your Company.
RegionAdmin May view and edit all orders in the region to which they are assigned.
BranchAdmin May view and edit all orders in the branch to which they are assigned.
Processor May view and edit all orders which they have the applicable BranchVisibility.
User May only view and edit their own orders.

In order to successfully add/remove a verifier using the API calls outline above, an individual must have the CorporateAdmin role within our system; otherwise, they will not be able to do so.

Adding a Verifier

Against the URL above, an individual who wishes to add an additional verifier at the company, region, or branch level will make the following API call:

POST to /v1/verifiers

Specification Details

In making this POST call, the following JSON will be passed in the body:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@example.com",
  "password": "my-secure-password",
  "mustChangePassword": true,
  "role": "CorporateAdmin",
  "isLocked": true,
  "regionId": 0,
  "branchId": 0,
  "generatePassword": true
}

See the table below for a list of fields, a description of each field, and whether they are required or not.

Field Description Required/Optional
firstName The first name of the Verifier. Required
lastName The last name of the Verifier. Required
email The email of the Verifier. This serves as the Verifier’s login name and is used for sending emails to the Verifier. Required
password This value is required when you are creating a new Verifier if not using generatePassword. When updating an existing Verifier, do not send it or send a null value to indicate no password change should happen. If you send a value when updating the Verifier, that Verifier’s password will be set to the value sent. Optional
mustChangePassword This value indicates whether this Verifier is required to change their password the next time they login to the AccountChek Verifier website. This does not affect their ability to use the API. Optional
role The role which the Verifier has within the system for your company. Required
isLocked Set to true when the Verifier is not allowed to login to the system. This is useful for keeping a Verifier in the system, but preventing them from performing operations. Optional
regionId This value is optional. It allows you to select from your hierarchy the region in which this Verifier is located. If you include this value, you must also include the branchId. Optional
branchId This value must be null or left off when no regionId is included, but if a regionId is included this value must also be included. This value is the id of a branch within the given region. The pair of regionId and branchId allow you specify a location at which the Verifier is located. Optional
generatePassword Set to true if you would like AccountChek to generate a password and send it to the Verifier via email. False means that you must include the password yourself via the password property. It is recommended that you include the password yourself. Required

See more detail on how to Create a Verifier in our Verifier API specifications.

Deleting a Verifier

Against the URL above, an individual who wishes to remove a verifier at the company level will make the following API call:

DELETE to /v1/verifiers/{verifierId}

Specification Details

In making this DELETE call, the verifierId in the endpoint will be the ID of the individual verifier you’re wanting to remove. If you aren’t sure of the ID of the individual verifier you’re wanting to remove, the following call can be used to retrieve it:

GET to /v1/verifiers

Specification Details

See more detail on how to Delete a Verifier and Get a Verifier in our Verifier API specifications.

Client Testing (CTE) Domains
  • https://verifierapi.accountchek.net
  • https://validatorapi.accountchek.net
Production Domains
  • https://verifierapi.accountchek.com
  • https://validatorapi.accountchek.com
AccountChek Statuses