DIVE Online API - Blacklist

The blacklist API endpoints allow the DIVE Online account to programmatically override any document results based on the premptive matching of data points set by the developer. If ALL data points match on a blacklist entry, the final result will be a failed attempt regardless of other checks.

These data points are:

• First Name
• Middle Name
• Last Name
• Date of Birth

/api/v2/public/Blacklist

[GET] /api/v2/public/Blacklist

Use Case - Retrieve the blacklist entries for the account.

Token - public API Token (pk_) or secret API Token (sk_)

Required Parameters None

Optional Parameters

• Page - specifies the page number to return. The value must be between 1 and 2147483647.
• PageSize - specifies the number of items to return per page. The value must be between 1 and 400.
• SortField - TODO: Add description for SortField.
• Order - can be either asc or desc to specify the order of the results.
• TextFilter - specifies a text string to filter the blacklist entries by.

Request Body None

Response Body

{
  "succeeded": true,
  "isError": true,
  "errors": [
    {
      "code": "string",
      "description": "string",
      "data": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "data": {
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "totalPages": 0,
    "items": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "firstName": "string",
        "middleName": "string",
        "familyName": "string",
        "dob": "2026-01-07T22:08:28.207Z"
      }
    ]
  }
}

Response Fields

• succeeded Indicates if the request was successful.
• isError Indicates if there was an error with the request.

errors � An array of error objects. This will populate if isError = true

• errors.code The error code.
• errors.description A description of the error.
• errors.data Additional data related to the error.
• errors.data.additionalProp1 Additional property 1. TODO : Add description for additionalProp1.
• errors.data.additionalProp2 Additional property 2. TODO : Add description for additionalProp2.
• errors.data.additionalProp3 Additional property 3. TODO : Add description for additionalProp3.

data � The main data object containing pagination and items.

• data.page The current page number.
• data.pageSize The number of items per page.
• data.total The total number of items.
• data.totalPages The total number of pages.

items � An array of blacklist entries.

• items.id (string) - The unique identifier for the blacklist entry.
• items.firstName (string) - The first name associated with the blacklist entry.
• items.middleName (string) - The middle name associated with the blacklist entry.
• items.familyName (string) - The last name associated with the blacklist entry.
• items.dob (string) - The date of birth associated with the blacklist entry in ISO 8601 format.

/api/v2/public/Blacklist

[POST] /api/v2/public/Blacklist

Use Case - Add a new entry to the blacklist.

Token - public API Token (pk_) or secret API Token (sk_)

Required Parameters None

Optional Parameters None

Request Body

{
  "firstName": "string",
  "middleName": "string",
  "familyName": "string",
  "dob": "2026-01-07"
}

• firstName (string) - The first name to be blacklisted.
• middleName (string) - The middle name to be blacklisted.
• familyName (string) - The last name to be blacklisted.
• dob (string) - The date of birth to be blacklisted in ISO 8601 format (YYYY-MM-DD).

Response Body

{
  "succeeded": true,
  "isError": true,
  "errors": [
    {
      "code": "string",
      "description": "string",
      "data": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "data": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response Fields

• succeeded Indicates if the request was successful.
• isError Indicates if there was an error with the request.

errors � An array of error objects. This will populate if isError = true

• errors.code The error code.
• errors.description A description of the error.
• errors.data Additional data related to the error.
• errors.data.additionalProp1 Additional property 1. TODO : Add description for additionalProp1.
• errors.data.additionalProp2 Additional property 2. TODO : Add description for additionalProp2.
• errors.data.additionalProp3 Additional property 3. TODO : Add description for additionalProp3.

• data (string) - The unique identifier for the newly created blacklist entry.
  

/api/v2/public/Blacklist/{personId}

[GET] /api/v2/public/Blacklist/{personId}

Use Case - Retrieve a specific blacklist entry by its unique identifier.

Token - public API Token (pk_) or secret API Token (sk_)

Required Parameters

• personId (string) - The unique identifier of the blacklist entry to retrieve.

Optional Parameters None

Request Body None

Response Body

{
  "succeeded": true,
  "isError": true,
  "errors": [
    {
      "code": "string",
      "description": "string",
      "data": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "firstName": "string",
    "middleName": "string",
    "familyName": "string",
    "dob": "2026-01-07T22:23:56.498Z"
  }
}

Response Fields

• succeeded Indicates if the request was successful.
• isError Indicates if there was an error with the request.

errors � An array of error objects. This will populate if isError = true

• errors.code The error code.
• errors.description A description of the error.
• errors.data Additional data related to the error.
• errors.data.additionalProp1 Additional property 1. TODO : Add description for additionalProp1.
• errors.data.additionalProp2 Additional property 2. TODO : Add description for additionalProp2.
• errors.data.additionalProp3 Additional property 3. TODO : Add description for additionalProp3.

data � The main data object containing items.

• data.id (string) - The unique identifier for the blacklist entry.
• data.firstName (string) - The first name associated with the blacklist entry.
• data.middleName (string) - The middle name associated with the blacklist entry.
• data.familyName (string) - The last name associated with the blacklist entry.
• data.dob (string) - The date of birth associated with the blacklist entry in ISO 8601 format.

/api/v2/public/Blacklist/{personId}

[PUT] /api/v2/public/Blacklist/{personId}

Use Case - Update an existing blacklist entry.

Token - public API Token (pk_) or secret API Token (sk_)

Required Parameters

• personId (string) - The unique identifier of the blacklist entry to update.

Optional Parameters None

Request Body

{
  "firstName": "string",
  "middleName": "string",
  "familyName": "string",
  "dob": "2026-01-07"
}

• firstName (string) - The updated first name for the blacklist entry.
• middleName (string) - The updated middle name for the blacklist entry.
• familyName (string) - The updated last name for the blacklist entry.
• dob (string) - The updated date of birth for the blacklist entry in ISO 8601 format (YYYY-MM-DD).

Response Body An HTTP 200 OK status code with no body content.

/api/v2/public/Blacklist/{personId}

[DELETE] /api/v2/public/Blacklist/{personId}

Use Case - Delete a specific blacklist entry by its unique identifier.

Token - public API Token (pk_) or secret API Token (sk_)

Required Parameters

• personId (string) - The unique identifier of the blacklist entry to delete.

Optional Parameters None

Request Body None

Response Body An HTTP 200 OK status code with no body content.