Cases (deprecated)

Cases API enables you to retrieve and update case records.

This is an object representing your Case in TransactionLink. You can retrieve it to see the current data of the Case.

We are discontinuing Cases in favor of Records, which are fully customizable. The documentation is automatically generated in the dashboard based on your configuration. If you do not have a configuration set up, please contact us at [e-mail]

POST Create Case

Create case

Create a case with provided data

post

/cases

Body

firstNamestring

First name

lastNamestring

Last name

personalNumberstring

Personal Number

emailstring

Email

companyNamestring

Comapny name

companyNumberstring

Company number

companyAddressstring

Company address

phoneobject

Phone

documentsobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.transactionlink.io/cases' \
  --header 'Content-Type: application/json' \
  --data '{"firstName":"Jan","lastName":"Nowak","personalNumber":17300211234,"email":"[e-mail]","companyName":"Company name","companyNumber":"Company number","companyAddress":"Company address","phone":{"countryCode":48,"number":666666666},"documents":[{"resourceId":"20fd5007-008d-447c-8378-6f81ea48fe65","resourceName":"File name.pdf","resourcePath":"resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf"},{"resourceId":"20fd5007-008d-447c-8378-6f81ea48fe65","resourceName":"File name.pdf","resourcePath":"resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf"}]}'

201

400

201

{
  "createdDate": "text",
  "caseId": "text",
  "partyId": "text",
  "partyDetails": {
    "business": {
      "companyNumber": "text",
      "companyName": "text",
      "companyAddress": "text"
    },
    "documents": [
      {
        "resourceId": "text",
        "resourceName": "text",
        "resourcePath": "text"
      }
    ],
    "personal": {
      "firstName": "text",
      "lastName": "text",
      "personalNumber": "text",
      "email": "text",
      "phone": {
        "countryCode": "text",
        "number": "text"
      }
    }
  }
}

Case was created successfully

GET Case

Get case

Get a case

get

/cases/{caseId}

Path parameters

caseIdstring · uuidrequired

UUID of the case to get

Header parameters

Acceptstringrequired

Can be 'application/json', 'application/json;version=1' or 'application/json;version=2'

Example: application/json

Responses

application/json; version=1application/json; version=2

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.transactionlink.io/cases/{caseId}' \
  --header 'Accept: application/json'

200

404

200

application/json; version=1

application/json; version=2

application/json; version=1

{
  "createdDate": "text",
  "caseId": "text",
  "partyId": "text",
  "partyDetails": {
    "business": {
      "companyNumber": "text",
      "companyName": "text",
      "companyAddress": "text"
    },
    "documents": [
      {
        "resourceId": "text",
        "resourceName": "text",
        "resourcePath": "text"
      }
    ],
    "personal": {
      "firstName": "text",
      "lastName": "text",
      "personalNumber": "text",
      "email": "text",
      "phone": {
        "countryCode": "text",
        "number": "text"
      }
    }
  }
}

Returns the case object