Retrieving Results

Once you have registered a financing application with a financing validation request in the /registrations end-point, you will use the unique identifier returned to retrieve the results of the validation.

There are four key endpoints that can be used to retrieve results: - GET /status (see also POST /status-requests) - GET /financing-validation-requests - GET /document-matches - GET /document-matches/{match-identification}

Further explanations of these four endpoints can be found sequentially below.

GET /status vs. GET /financing-validation-requests

The GET /financing-validation-requests endpoint differs from GET /status by providing results for a filtered list of FVRs, utilizing a range of parameters, rather than for a single request. GET /status exclusively uses the request-identification field as a parameter to retrieve individual FVR details. While the status retreival identification in GET /financing-validation-requests differs from that of GET /status, the results retrieved are the same. The match_identification field returned by these endpoints can then be used to retrieve line by line matching information from GET /document-matches.

GET /document-matches vs. GET /document-matches/{match-identification}

GET /document-matches endpoint differs from GET /document-matches/{match-identification} by providing results for a filtered list of document matches, utilizing a range of parameters, rather than for a single request. GET /document-matches/{match-identification} exclusively uses the match-identification field as a parameter to retrieve individual document match details involving the calling entity as financier. While the status retrieval identification in GET /document-matches/{match-identification} differs from that of GET /document-matches, the results retrieved are the same.

GET /status

The GET /status endpoint serves to retrieve financing validation request registration and financing status details at the validation service.

Retrieval

You can retrieve status by using request_identification.

{ "request_identification": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }

This request_identification can be generated automatically upon registration (see Registrations) or manually using the POST /status-requests endpoint. POST /status-requests creates a new financing validation request set definition for subsequent status retrieval from the GET /status endpoint.

Full Request Code Examples

Bash:

curl --request GET \
  --url https://api.securefinancing.com/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  --header 'Authorization: Bearer ' \
  --header 'Content-Type: application/json'

Javascript:

fetch(
  "https://api.securefinancing.com/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer ",
    },
  }
)
  .then((response) => {
    console.log(response);
  })
  .catch((err) => {
    console.error(err);
  });

Python:

import http.client

conn = http.client.HTTPSConnection("api.securefinancing.com")

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer "
    }

conn.request("GET", "/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Java:

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.securefinancing.com/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer ")
  .build();

Response response = client.newCall(request).execute();

Results

A successful response will display the status of the registered data sets in the validation service. The results will be paginated. The status will include key information including: - financing_validation_data_set_details: registration details on the Financing Validation Requests within the data sets - document_duplicate_matches: match identifier for a detected exact or partial match if applicable. Note that this identifier is for the match, not an identifier for the document against which yours is matched. - financing_request_status: status of the FVR, reflecting registration, financing, cancellation, failure, or pending. - financing_request_duplicate_report: detailed breakdown of matches (if detected) including identification, type, matched FVR status and amount, and time matched.

Internal vs External Matches

matched_financing_request_submitter : This structure within the financing_request_duplicate_report array provides information on the matched FVR’s submitter. By looking at the contents of this structure, the user can distinguish an internal (within submitter organization) match from an external (across submitter organizations) one. While the former one will have the name field set to its own (user’s/submitter’s) name, an external match will either have the name field set to null (“name”:null) or it will be absent altogether along the containing matched_financing_request_submitter structure. In the response example shown below, the 3 matches in the financing_request_duplicate_request array are external, as indicated by the null name values in the matched_financing_request_submitter structures.

For more information on analyzing these results obtained through GET /status, see Analyzing Results & Matches.

Full Response Code Example

{
  "links": [
    {
      "href": "https://api.securefinancing.com/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6?limit=20,offset=0",
      "rel": "self",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6?limit=20,offset=0",
      "rel": "first",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/status/3fa85f64-5717-4562-b3fc-2c963f66afa6?limit=20,offset=0",
      "rel": "next",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/activity?limit=20,offset=0",
      "rel": "previous",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/activity?limit=20,offset=0",
      "rel": "last",
      "type": "GET"
    }
  ],
  "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
  "submitting_financial_institution_identification": "SWHQBEBBXXX",
  "creation_date_time": "2022-06-20T13:50:22.002Z",
  "financing_validation_data_set_details": [
    {
      "pool_identification": "e84aedfd-58e6",
      "submitter_batch_identification": "4f576e47-aff6",
      "batch_identification": "95cf1c7d-387a-42d8-bb45-27bcd90fb6a3",
      "batch_booking": false,
      "submitter_data_set_identification": "b59ce8a1-bb32",
      "data_set_identification": "6bc2a104-acac-45b9-a5b0-47f734f8c2ba",
      "data_set_validation_service": "REGI",
      "financing_applicant": {
        "name": "Ernser Schmeler and Wiegand LLC",
        "identifications": null,
        "country_of_domicile": "SH"
      },
      "financed_amount": null,
      "collateral_type": "CASH",
      "pre_shipment_financing": null,
      "with_recourse": null,
      "referred_documents": [
        {
          "submitter_document_reference": "51e25cf2-80af",
          "country_of_issue": null,
          "trade_utility_service": [],
          "document_summary": {
            "document_type": "CINV",
            "issue_date": "2022-04-04",
            "document_issuer_identification": null,
            "seller_identification": {
              "name": "Klein - Murazik LLC",
              "identifications": null,
              "country_of_domicile": "DZ"
            },
            "buyer_identification": {
              "name": "Jenkins Swaniawski and Roberts LLC",
              "identifications": null,
              "country_of_domicile": "VE"
            },
            "invoice_number": "ANH-D7OZAJZ4QH22DZH",
            "total_invoice_amount": {
              "currency": "XFU",
              "amount": "104705.63"
            },
            "commercial_line_items": [],
            "ship_to_name": null,
            "ship_to_address_line": [],
            "ship_to_country": null,
            "payment_method": null
          },
          "registered_document_identification": "decdb81d-6edc-4902-bc5f-c7af805c8696",
          "trade_utility_matching": [],
          "trade_utility_data": [],
          "document_duplicate_matches": {
            "exact_matches": ["172f404a-ef34-4b67-8e50-387df33a0eb2"],
            "partial_matches": [
              "0c45ad07-4908-429c-9ea1-06de642b9389",
              "3b1c6bbb-8acc-4336-8b66-3985fb177653"
            ]
          }
        }
      ],
      "financing_request_status": "REDU",
      "financing_request_duplicate_report": [
        {
          "related_document_match_identifications": [
            "a1229cca-5aac-4636-81af-7b971b7f11ef",
            "decdb81d-6edc-4902-bc5f-c7af805c8696"
          ],
          "match_identification": "ec68360b-9669-496a-9739-3b0102215201",
          "match_type": "PART",
          "matched_financing_request_identification": "ec68360b-9669-496a-9739-3b0102215201",
          "matched_financing_request_submitter": {
            "name": null,
            "identifications": {
              "any_bic": "*",
              "lei": "*",
              "email_address": "*",
              "other": []
            },
            "country_of_domicile": "*"
          },
          "matched_financing_request_status": "REGU",
          "financing_applicant_is_matched": true,
          "matched_date_time": "2022-12-08T05:46:54.121Z",
          "proprietary_matching_details": {
            "proprietary_description": "MEDIUM_SIMILARITY"
          }
        },
        {
          "related_document_match_identifications": [
            "de0f6415-485f-46c1-8a48-e2c0d53763c0",
            "decdb81d-6edc-4902-bc5f-c7af805c8696"
          ],
          "match_identification": "5f190e88-beaf-4fba-9f50-cfaecfdfe626",
          "match_type": "PART",
          "matched_financing_request_identification": "5f190e88-beaf-4fba-9f50-cfaecfdfe626",
          "matched_financing_request_submitter": {
            "name": null,
            "identifications": {
              "any_bic": "*",
              "lei": "*",
              "email_address": "*",
              "other": []
            },
            "country_of_domicile": "*"
          },
          "matched_financing_request_status": "REGU",
          "financing_applicant_is_matched": true,
          "matched_date_time": "2022-12-08T05:46:54.635Z",
          "proprietary_matching_details": {
            "proprietary_description": "HIGH_SIMILARITY"
          }
        },
        {
          "related_document_match_identifications": [
            "04d8dd8e-21f2-4b4e-a7d9-38ae9e575f03",
            "decdb81d-6edc-4902-bc5f-c7af805c8696"
          ],
          "match_identification": "bcc6fa38-352c-4863-aa5e-d2f660d05030",
          "match_type": "EXCT",
          "matched_financing_request_identification": "bcc6fa38-352c-4863-aa5e-d2f660d05030",
          "matched_financing_request_submitter": {
            "name": null,
            "identifications": {
              "any_bic": "*",
              "lei": "*",
              "email_address": "*",
              "other": []
            },
            "country_of_domicile": "*"
          },
          "matched_financing_request_status": "REDU",
          "financing_applicant_is_matched": true,
          "matched_date_time": "2022-12-08T05:46:54.901Z",
          "proprietary_matching_details": {
            "proprietary_description": "CRITICAL_SIMILARITY"
          }
        }
      ],
      "errors": []
    }
  ]
}

GET /Financing-Validation-Requests

The GET /financing-validation-requests endpoint provides results for a filtered list of FVRs- utilizing a range of parameters- rather than for a single request. While the status retrieval identification in GET /financing-validation-requests differs from that of GET /status, the results retrieved are the same.

Retrieval

Status can be retrieved using several different identifiers: - pool_identification (retrieve status for all FVRs defined in this pool) - batch_identification (retrieve status for all FVRs defined in this batch) - submitter_data_set_identification (retrieve status for this single FVR)

Pool ID:

{
      "pool_identification": "monetago_20220620"
}

Batch ID:

{
      "batch_identification": "69777657-0137-4436-99fd-73a86b875a1f"
}

Data Set ID:

{
      "submitter_data_set_identification": "monetago_20220620_1_1"
}

In addition to the three identifiers defined above,GET /financing-validation-requests also allows the user to retrieve the status of FVRs based on a wide variety of parameters. Some of these parameters include: - before after (date-time) - collateral_type - duplicate_match_type - For full list of possible inputs, please see the GET /financing-validation-requests Endpoint in the API Specification.

Results

The results retrieved from GET /financing-validation-requests are the same as those from GET /status. For more information on the results, see the Results section under GET /status above.

If parameters provided for GET /financing-validation-requests are valid but no FVR’s are returned for those filters e.g. the beneficiary specified does not exist, then an empty array will be returned along with a 200 success code.

{
  "links": [
    {
      "href": "https://api.securefinancing.com/v1/financing-validation-requests?limit=20,offset=0",
      "rel": "self",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/financing-validation-requests?limit=20,offset=0",
      "rel": "first",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/financing-validation-requests?limit=20,offset=0",
      "rel": "next",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/financing-validation-requests?limit=20,offset=0",
      "rel": "previous",
      "type": "GET"
    },
    {
      "href": "https://api.securefinancing.com/v1/financing-validation-requests?limit=20,offset=0",
      "rel": "last",
      "type": "GET"
    }
  ],
  "submitting_financial_institution_identification": "d3ae6e40-af9e-4bc5-af93-35f714b611a2",
  "financing_validation_data_set_details": [
    {
      "pool_identification": "e84aedfd-58e6",
      "submitter_batch_identification": "4f576e47-aff6",
      "batch_identification": "95cf1c7d-387a-42d8-bb45-27bcd90fb6a3",
      "batch_booking": false,
      "submitter_data_set_identification": "b59ce8a1-bb32",
      "data_set_identification": "6bc2a104-acac-45b9-a5b0-47f734f8c2ba",
      "data_set_validation_service": "REGI",
      "financing_applicant": {
        "name": "Ernser Schmeler and Wiegand LLC",
        "identifications": null,
        "country_of_domicile": "SH"
      },
      "financed_amount": null,
      "collateral_type": "CASH",
      "pre_shipment_financing": null,
      "with_recourse": null,
      "referred_documents": [
        {
          "submitter_document_reference": "51e25cf2-80af",
          "country_of_issue": null,
          "trade_utility_service": [],
          "document_summary": {
            "document_type": "CINV",
            "issue_date": "2022-04-04",
            "document_issuer_identification": null,
            "seller_identification": {
              "name": "Klein - Murazik LLC",
              "identifications": null,
              "country_of_domicile": "DZ"
            },
            "buyer_identification": {
              "name": "Jenkins Swaniawski and Roberts LLC",
              "identifications": null,
              "country_of_domicile": "VE"
            },
            "invoice_number": "ANH-D7OZAJZ4QH22DZH",
            "total_invoice_amount": {
              "currency": "XFU",
              "amount": "104705.63"
            },
            "commercial_line_items": [],
            "ship_to_name": null,
            "ship_to_address_line": [],
            "ship_to_country": null,
            "payment_method": null
          },
          "registered_document_identification": "decdb81d-6edc-4902-bc5f-c7af805c8696",
          "trade_utility_matching": [],
          "trade_utility_data": [],
          "document_duplicate_matches": {
            "exact_matches": ["172f404a-ef34-4b67-8e50-387df33a0eb2"],
            "partial_matches": [
              "0c45ad07-4908-429c-9ea1-06de642b9389",
              "3b1c6bbb-8acc-4336-8b66-3985fb177653"
            ]
          }
        }
      ],
      "financing_request_status": "REDU",
      "financing_request_duplicate_report": [
        {
          "related_document_match_identifications": [
            "a1229cca-5aac-4636-81af-7b971b7f11ef",
            "decdb81d-6edc-4902-bc5f-c7af805c8696"
          ],
          "match_identification": "ec68360b-9669-496a-9739-3b0102215201",
          "match_type": "PART",
          "matched_financing_request_identification": "ec68360b-9669-496a-9739-3b0102215201",
          "matched_financing_request_submitter": {
            "name": null,
            "identifications": {
              "any_bic": "*",
              "lei": "*",
              "email_address": "*",
              "other": []
            },
            "country_of_domicile": "*"
          },
          "matched_financing_request_status": "REGU",
          "financing_applicant_is_matched": true,
          "matched_date_time": "2022-12-08T05:46:54.121Z",
          "proprietary_matching_details": {
            "proprietary_description": "MEDIUM_SIMILARITY"
          }
        },
        {
          "related_document_match_identifications": [
            "de0f6415-485f-46c1-8a48-e2c0d53763c0",
            "decdb81d-6edc-4902-bc5f-c7af805c8696"
          ],
          "match_identification": "5f190e88-beaf-4fba-9f50-cfaecfdfe626",
          "match_type": "PART",
          "matched_financing_request_identification": "5f190e88-beaf-4fba-9f50-cfaecfdfe626",
          "matched_financing_request_submitter": {
            "name": null,
            "identifications": {
              "any_bic": "*",
              "lei": "*",
              "email_address": "*",
              "other": []
            },
            "country_of_domicile": "*"
          },
          "matched_financing_request_status": "REGU",
          "financing_applicant_is_matched": true,
          "matched_date_time": "2022-12-08T05:46:54.635Z",
          "proprietary_matching_details": {
            "proprietary_description": "HIGH_SIMILARITY"
          }
        },
        {
          "related_document_match_identifications": [
            "04d8dd8e-21f2-4b4e-a7d9-38ae9e575f03",
            "decdb81d-6edc-4902-bc5f-c7af805c8696"
          ],
          "match_identification": "bcc6fa38-352c-4863-aa5e-d2f660d05030",
          "match_type": "EXCT",
          "matched_financing_request_identification": "bcc6fa38-352c-4863-aa5e-d2f660d05030",
          "matched_financing_request_submitter": {
            "name": null,
            "identifications": {
              "any_bic": "*",
              "lei": "*",
              "email_address": "*",
              "other": []
            },
            "country_of_domicile": "*"
          },
          "matched_financing_request_status": "REDU",
          "financing_applicant_is_matched": true,
          "matched_date_time": "2022-12-08T05:46:54.901Z",
          "proprietary_matching_details": {
            "proprietary_description": "CRITICAL_SIMILARITY"
          }
        }
      ],
      "errors": []
    }
  ]
}

GET /Document-Matches/{match-identification}

The GET /document-matches/{match-identification} endpoint provides information on a detected match to your registered or financed financing validation request. Requesting status utilizing match_identification retrieves individual document match details involving the calling entity as financier.

Retrieval

You can retrieve document match information in this endpoint using request_identification.

{ "match_identification": "c0a6263c-70ea-4035-843c-e4a066bc6927" }

Full Request Code Examples

Bash:

curl --request GET \
  --url https://api.securefinancing.com/v1/document-matches/c0a6263c-70ea-4035-843c-e4a066bc6927 \
  --header 'Authorization: Bearer ' \
  --header 'Content-Type: application/json'

Javascript:

fetch(
  "https://api.securefinancing.com/v1/document-matches/c0a6263c-70ea-4035-843c-e4a066bc6927",
  {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer ",
    },
  }
)
  .then((response) => {
    console.log(response);
  })
  .catch((err) => {
    console.error(err);
  });

Python:

import http.client

conn = http.client.HTTPSConnection("api.securefinancing.com")

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer "
    }

conn.request("GET", "/v1/document-matches/c0a6263c-70ea-4035-843c-e4a066bc6927", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Java:

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.securefinancing.com/v1/document-matches/c0a6263c-70ea-4035-843c-e4a066bc6927")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer ")
  .build();

Response response = client.newCall(request).execute();

Results

A successful response will display the match information of the requested match identification. The status will include key information including: - match_identification - match_type - matched_record_submitter - matched_date_time - matching_report

For more information on analyzing these results obtained through GET /document-matches, see Analyzing Results & Matches.

Full Response Code Example

{
  "match_identification": "c0a6263c-70ea-4035-843c-e4a066bc6927",
  "match_type": "PART",
  "matched_date_time": "2022-06-20T13:50:23.759Z",
  "matching_report": [
    {
      "element_name": "issue_date",
      "matching_status": "MACH"
    },
    {
      "element_name": "seller_identification.name",
      "matching_status": "MACH"
    },
    {
      "element_name": "seller_identification.country_of_domicile",
      "matching_status": "MACH"
    },
    {
      "element_name": "buyer_identification.name",
      "matching_status": "NMAT"
    },
    {
      "element_name": "buyer_identification.country_of_domicile",
      "matching_status": "MACH"
    },
    {
      "element_name": "invoice_number",
      "matching_status": "NMAT",
      "mismatched_element": {
        "provided_value": "inv001",
        "compared_value": "inv002"
      }
    },
    {
      "element_name": "total_invoice_amount.currency",
      "matching_status": "MACH"
    },
    {
      "element_name": "total_invoice_amount.amount",
      "matching_status": "NMACH",
      "mismatched_element": {
        "provided_value": "1,980,025.15",
        "compared_value": "563,340.74"
      }
    }
  ],
  "proprietary_matching_details": {
    "proprietary_description": "LOW_SIMILARITY"
  }
}

GET /Document-Matches

The GET /document-matches endpoint provides information on detected matches to your registered or financed financing validation requests. Requesting status utilizing the range of parameters retrieves a filtered list of document match details involving the calling entity as financier, conforming the the query parameters.

Retrieval

Status can be retrieved using several different parameters including:

  • before after (date-time)
  • match_type
  • For full list of possible inputs, please see the GET /document-matches Endpoint in the API Specification.

Full Request Code Examples

Bash:

curl --request GET \
  --url https://api.securefinancing.com/v1/document-matches/d827f76c-c42f-45ae-8972-0597dce2c6e6 \
  --header 'Authorization: Bearer ' \
  --header 'Content-Type: application/json'

Javascript:

fetch(
  "https://api.securefinancing.com/v1/document-matches/d827f76c-c42f-45ae-8972-0597dce2c6e6",
  {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer ",
    },
  }
)
  .then((response) => {
    console.log(response);
  })
  .catch((err) => {
    console.error(err);
  });

Python:

import http.client

conn = http.client.HTTPSConnection("api.securefinancing.com")

headers = {
    'Content-Type': "application/json",
    'Authorization': "Bearer "
    }

conn.request("GET", "/v1/document-matches/d827f76c-c42f-45ae-8972-0597dce2c6e6", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Java:

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.securefinancing.com/v1/document-matches/d827f76c-c42f-45ae-8972-0597dce2c6e6")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer ")
  .build();

Response response = client.newCall(request).execute();

Results

The results retrieved from GET /Document-Matches{match-identification} are the same as those from GET /document-matches. For more information on the results, see the Results section under GET /document-matches above.

Next > Financings

Previous < Registrations