Cases

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.

POST Create Case

Create case

Create a case with provided data

POSThttps://api.transactionlink.io/cases

Body

application/json

firstNamestring

First name

lastNamestring

Last name

personalNumberstring

Personal Number

emailstring

Email

phoneobject

Phone

companyNamestring

Comapny name

companyNumberstring

Company number

companyAddressstring

Company address

documentsarray of object

Response

201400

Case was created successfully

Body

application/json

createdDate*string

Creation time

caseId*string

Case Id

partyId*string

Case id

partyDetails*object

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/cases', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "Jan",
      "lastName": "Nowak",
      "personalNumber": 17300211234,
      "email": "[e-mail]",
      "phone": {
        "countryCode": 48,
        "number": 666666666
      },
      "companyName": "Company name",
      "companyNumber": "Company number",
      "companyAddress": "Company address",
      "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"
        }
      ]
    }),
});
const data = await response.json();

Response

201400

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

GET Case

Get case

Get a case

GEThttps://api.transactionlink.io/cases/{caseId}

Path parameters

caseId*string (uuid)

UUID of the case to get

Header parameters

Response

200404

Returns the case object

Body

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

createdDate*string

Creation time

caseId*string

Case Id

partyId*string

Case id

partyDetails*object

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/cases/{caseId}', {
    method: 'GET',
    headers: {
      "Accept": "application/json"
    },
});
const data = await response.json();

Response

200404

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