Skip to content
Connect API Catalog/
/
/
Update FreshInvestigation...

Update FreshInvestigation Report Content

Request

Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered.

Security
bearerToken
Path
orderIdstringrequired

Fresh investigation orderId

Bodyapplication/json
consentboolean

Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report

contactInfoobject(ConnectFreshInvInvestigationContactInfo)

Your contact information

chargeReferencestring

Free text field to add your own personal reference to the order

searchCriteriaobject(ConnectFreshInvInvestigationCompanyData)

Details on the company.

pendingInfoobject

PendingInfo property contains the information of respective sections, that someone has requested respective information to be modified.

curl -i -X PATCH \
  'https://connect.sandbox.creditsafe.com/v1/freshinvestigations/{orderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consent": true,
    "contactInfo": {
      "name": "string",
      "emailAddress": "string",
      "telephoneNumber": "string",
      "company": {
        "name": "string",
        "number": "string"
      }
    },
    "chargeReference": "string",
    "searchCriteria": {
      "name": "string",
      "additionalInfo": "string",
      "telephoneNumber": "string",
      "address": {
        "simple": "string",
        "postcode": "string",
        "city": "string"
      },
      "regNo": "string",
      "vatNo": "string",
      "countryCode": "AF"
    },
    "pendingInfo": {
      "contactDetails": {
        "name": "string",
        "emailAddress": "string",
        "telephoneNumber": "string",
        "company": {
          "name": "string",
          "number": "string"
        }
      },
      "searchCriteria": {
        "name": "string",
        "additionalInfo": "string",
        "telephoneNumber": "string",
        "address": {
          "simple": "string",
          "postcode": "string",
          "city": "string"
        },
        "regNo": "string",
        "vatNo": "string",
        "countryCode": "AF"
      }
    }
  }'

Responses

Investigation Report.

Bodyapplication/json
messagestring

Success response of updated fresh investigation.

Example:"FreshInvestigation OrderId is being updated"
Response
{
  "message": "FreshInvestigation OrderId is being updated"
}