Similar List API

This API allows managing lists of similar entities in the system. It provides endpoints to create, read, update, and delete similar lists, as well as to update the status of a specific list.

The ListOfSimilar Object

The ListOfSimilar object represents a list of similar entities associated with a borrower.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "borrowerId": "789e4567-e89b-12d3-a456-426614174111",
  "executionId": "456e4567-e89b-12d3-a456-426614174222",
  "listOfSimilar": [
    {
      "label": "Option 1",
      "description": "This is the first similar option",
      "entities": [
        {
          "entityType": "address",
          "key": "street",
          "proposedValue": "123 Main St"
        }
      ]
    }
  ],
  "status": "pending",
  "appliedIndex": null,
  "appliedBy": null,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}

Attributes

proposedValue type

proposedValue is polymorphic and depends on the entity's configured data type:

• For most fields it can be a String (e.g. "123 Main St").
• For money fields it must be an Object with both amount and currency (full replacement):

{
  "entityType": "borrower_field",
  "key": "monthly_revenue",
  "proposedValue": { "amount": "2000", "currency": "MXN" }
}

status Field

This field represents the status of the similar list:

Available Operations

Create a New Similar List

Creates a new list of similar entities in the system. Any other pending list associated with the same borrower will become expired.

POST /v1/list-of-similar

Input Parameters:

Request Example:

{
  "borrowerId": "789e4567-e89b-12d3-a456-426614174111",
  "executionId": "456e4567-e89b-12d3-a456-426614174222",
  "listOfSimilar": [
    {
      "label": "Option 1",
      "description": "This is the first similar option",
      "entities": [
        {
          "entityType": "address",
          "key": "street",
          "proposedValue": "123 Main St"
        }
      ]
    }
  ]
}

Successful Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Get a Similar List

Retrieves the information of a specific similar list.

GET /v1/list-of-similar/:list_id

Path Parameters:

Successful Response:

The response will be a complete ListOfSimilar object, as described above.

Apply an Entry from the Similar List

Applies a specific entry from the similar list, changing its status to applied.

POST /v1/list-of-similar/:list_id/apply

Path Parameters:

Input Parameters:

Request Example:

{
  "index": 0,
  "retryWorkflow": true
}

Successful Response:

Status code 204 (No Content) if the application was successful.

Report a Similar List Entry as "no_hit"

Changes the status of a specific similar list entry to no_hit.

POST /v1/list-of-similar/:list_id/no-hit

Path Parameters:

Input Parameters:

Request Example:

{
  "retryWorkflow": false
}

Successful Response:

Status code 204 (No Content) if the report was successful.

Delete a Similar List

Deletes a similar list from the system.

DELETE /v1/list-of-similar/:list_id

Path Parameters:

Successful Response:

Status code 204 (No Content) if the deletion was successful.

List Similar Lists

Retrieves a paginated list of similar lists with filtering and sorting options.

GET /v1/list-of-similar

Query Parameters:

Successful Response:

The response will be a paginated list of ListOfSimilar objects.

Error Handling

The API may return the following error codes:

Errors will include a descriptive message in the response body.