Search
K
lodgement v1

Lodgement Case Summary

This API is used to get the lodgement case summary for an existing workspace

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases

Query Parameters

workspace_idstring(uuid)required

workspace-id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/json

OK

recordsarray[object]
Show Child Parameters
get/partner/api/platformconnect/v1/lodgement-cases
  
curl --request GET \
  --url 'https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases?workspace_id=' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "records": [
    {
      "lodgementCaseId": "lodgementCaseId",
      "lodgementCaseStatus": "lodgementCaseStatus",
      "workspaceId": "workspaceId",
      "workspaceReferenceId": "workspaceReferenceId",
      "lastTitleSearchStatus": "lastTitleSearchStatus",
      "transactionType": "transactionType",
      "applications": [
        {
          "applicationId": "applicationId",
          "applicationType": "MORTGAGE_DEED",
          "status": "status",
          "submittedAt": "submittedAt",
          "auditAttributes": {
            "createdAt": "createdAt",
            "createdBy": "createdBy",
            "lastModifiedAt": "lastModifiedAt",
            "lastModifiedBy": "lastModifiedBy"
          },
          "file": {
            "fileId": "fileId",
            "fileName": "sample_document.pdf",
            "fileUploadStatus": "SUCCESS",
            "auditAttributes": {
              "createdAt": "createdAt",
              "createdBy": "createdBy",
              "lastModifiedAt": "lastModifiedAt",
              "lastModifiedBy": "lastModifiedBy"
            }
          },
          "attributes": {
            "applicationType": "applicationType",
            "transactionValue": 100,
            "landRegistryFee": 100,
            "certificationType": "CERTIFIED",
            "mortgageDeedReference": "DN100",
            "mortgageDeedReferenceType": "PAPER",
            "isEffective": true
          },
          "parties": [
            {
              "partyId": "partyId",
              "type": "INDIVIDUAL",
              "role": "role",
              "partyDetails": {
                "type": "INDIVIDUAL"
              }
            }
          ]
        }
      ],
      "auditAttributes": {
        "createdAt": "createdAt",
        "createdBy": "createdBy",
        "lastModifiedAt": "lastModifiedAt",
        "lastModifiedBy": "lastModifiedBy"
      },
      "titles": [
        {
          "titleId": "titleId",
          "titleNumber": "DN100"
        }
      ]
    }
  ]
}

Download Lodgement Document - PDF

This API is used to download document content in PDF format from an existing workspace

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/documents

Query Parameters

document_typestringrequired

Document type Allowed Values: [‘TITLE_INFORMATION_DOCUMENT’]

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/octet-stream

OK

string
get/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/documents
  
curl --request GET \
  --url 'https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases//documents?document_type=' \
  --header 'Accept: application/octet-stream, application/json' \
  --header 'Content-Type: application/octet-stream'
application/octet-stream
"%PDF-1.4 % 1 0 obj << /Type /Catalog /Version /1.7 /Pages 2 0 R >> endobj 3 0 obj << /CreationDate (D:20230811125238+00'00') /Producer (openhtmltopdf.com) /Title (Mortgage Deed) >> endobj 2 0 obj << /Type /Pages /Kids [4 0 R] /Count 1 >> endobj 4 0 obj << /Type /Page /MediaBox [0.0 0.0 595.275 841.875] /Parent 2 0 R /Contents 5 0 R /Resources 6 0 R >> endobj 5 0 obj << /Length 2649 /Filter /FlateDecode >> stream ……… ……… ……… ……… endstream endobj 6 0 obj << /Font 7 0 R >> endobj 7 0 obj << /F1 8 0 R /F2 9 0 R >> endobj 8 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >> endobj 9 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica-Bold /Encoding /WinAnsiEncoding >> endobj xref 0 10 0000000000 65535 f 0000000015 00000 n 0000000192 00000 n 0000000078 00000 n 0000000249 00000 n 0000000365 00000 n 0000003089 00000 n 0000003122 00000 n 0000003163 00000 n 0000003260 00000 n trailer << /Root 1 0 R /Info 3 0 R /ID [<0C3941FE18ED1D13A75215A5CFC207E1> <0C3941FE18ED1D13A75215A5CFC207E1>] /Size 10 >> startxref 3362 %%EOF\n"

Update Lodgement Application Attribute

This API is used to update the attribute values for a given lodgement application id

patch
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

application_idstring(uuid)required

Application id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
transactionValuenumber

Example:100

mortgageDeedReferencestring

Example:DN100

mortgageDeedReferenceTypestring

Allowed values:
[PAPER, DIGITAL]

Match pattern:^(PAPER|DIGITAL)$

Example:PAPER

isEffectiveboolean

Example:true

Response

application/json

OK

applicationIdstring(uuid)read-only
applicationTypestring

Example:MORTGAGE_DEED

statusstringread-only
submittedAtstring(date-time)
submittedBystring
auditAttributesobject
Show Child Parameters
fileobject
Show Child Parameters
attributesobject
Show Child Parameters
patch/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}

Body

{}
{}
  
curl --request PATCH \
  --url https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases//applications/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}'
application/json
{
  "applicationId": "applicationId",
  "applicationType": "MORTGAGE_DEED",
  "status": "status",
  "submittedAt": "submittedAt",
  "submittedBy": "submittedBy",
  "auditAttributes": {
    "createdAt": "createdAt",
    "createdBy": "createdBy",
    "lastModifiedAt": "lastModifiedAt",
    "lastModifiedBy": "lastModifiedBy"
  },
  "file": {
    "fileId": "fileId",
    "fileName": "sample_document.pdf",
    "fileUploadStatus": "SUCCESS",
    "auditAttributes": {
      "createdAt": "createdAt",
      "createdBy": "createdBy",
      "lastModifiedAt": "lastModifiedAt",
      "lastModifiedBy": "lastModifiedBy"
    }
  },
  "attributes": {
    "applicationType": "applicationType",
    "transactionValue": 100,
    "landRegistryFee": 100,
    "certificationType": "CERTIFIED",
    "mortgageDeedReference": "DN100",
    "mortgageDeedReferenceType": "PAPER",
    "isEffective": true
  }
}

Upload and Attach Document

This API is used to upload & attach a document to the lodgement application associated to the workspace, such as a mortgage deed

Note: In the event of eDeed please update mortgageDeedReference and mortgageDeedReferenceType using Update Lodgement Application Attribute before uploading

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}/attachments

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

application_idstring(uuid)required

Application id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

multipart/form-data
filestringrequired

Allowed format: [PDF]

Example:sample_document.pdf

documentTypestringrequired

Allowed values: [MORTGAGE_DEED,
EVIDENCE,
CORRESPONDENCE,
IDENTITY_EVIDENCE,
IDENTITY_FORM,
BIRTH_CERTIFICATE,
MARRIAGE_CERTIFICATE,
STATEMENT_OF_TRUTH,
STATUTORY_DECLARATION,
PG82_CERTIFICATE,
COMPANIES_HOUSE_CERTIFICATE,
COMPANIES_HOUSE_EVIDENCE]

Example:MORTGAGE_DEED

documentCategorystringrequired

Allowed values: [APPLICATION_DOCUMENT, SUPPORTING_DOCUMENT]

Example:APPLICATION_DOCUMENT

certificationTypestringrequired

Allowed values: [CERTIFIED, ORIGINAL, SCANNED]

Match pattern:(CERTIFIED|ORIGINAL|SCANNED)

Example:CERTIFIED

Response

application/json

ACCEPTED

fileIdstring(uuid)required
post/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}/attachments

Body

{
  "file": "sample_document.pdf",
  "documentType": "MORTGAGE_DEED",
  "documentCategory": "APPLICATION_DOCUMENT",
  "certificationType": "CERTIFIED"
}
{ "file": "sample_document.pdf", "documentType": "MORTGAGE_DEED", "documentCategory": "APPLICATION_DOCUMENT", "certificationType": "CERTIFIED" }
  
curl --request POST \
  --url https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases//applications//attachments \
  --header 'Accept: application/json' \
  --header 'Content-Type: multipart/form-data' \
  --data '{
  "file": "sample_document.pdf",
  "documentType": "MORTGAGE_DEED",
  "documentCategory": "APPLICATION_DOCUMENT",
  "certificationType": "CERTIFIED"
}'
application/json
{
  "fileId": "fileId"
}

Upload Document

This API is used to upload documents to workspace such as offer document as well as upload & attach a document to the lodgement application associated to the workspace, such as a mortgage deed.

Note: In the event of eDeed please update mortgageDeedReference and mortgageDeedReferenceType using Update Lodgement Application Attribute before uploading

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/files

Path Parameters

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

multipart/form-data
filestringrequired

Allowed format: [PDF]

Example:sample_document.pdf

documentTypestringrequired

Allowed values: [MORTGAGE_DEED,
BIRTH_CERTIFICATE,
CORRESPONDENCE,
EVIDENCE,
IDENTITY_EVIDENCE,
IDENTITY_FORM,
MARRIAGE_CERTIFICATE,
STATEMENT_OF_TRUTH,
STATUTORY_DECLARATION,
MORTGAGE_OFFER,
REDEMPTION_STATEMENT,
PG82_CERTIFICATE,
COMPANIES_HOUSE_CERTIFICATE,
COMPANIES_HOUSE_EVIDENCE]

Example:MORTGAGE_DEED

applicationIdstring(uuid)

To attach the uploaded document to a specific application, the corresponding Application ID must be provided. This value is not required when uploading a document to Workspace without having to attach to an application.

Example:123e4567-e89b-12d3-a456-426614174000

documentCategorystringrequired

Allowed values: [APPLICATION_DOCUMENT,
SUPPORTING_DOCUMENT,
WORKSPACE_SUPPORTING_DOCUMENT]

Example:APPLICATION_DOCUMENT

certificationTypestring

Allowed values: [CERTIFIED, ORIGINAL, SCANNED]

Match pattern:(CERTIFIED|ORIGINAL|SCANNED)

Example:CERTIFIED

Response

application/json

ACCEPTED

fileIdstring(uuid)required
post/partner/api/platformconnect/v1/workspaces/{workspace_id}/files

Body

{
  "file": "sample_document.pdf",
  "documentType": "MORTGAGE_DEED",
  "documentCategory": "APPLICATION_DOCUMENT"
}
{ "file": "sample_document.pdf", "documentType": "MORTGAGE_DEED", "documentCategory": "APPLICATION_DOCUMENT" }
  
curl --request POST \
  --url https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces//files \
  --header 'Accept: application/json' \
  --header 'Content-Type: multipart/form-data' \
  --data '{
  "file": "sample_document.pdf",
  "documentType": "MORTGAGE_DEED",
  "documentCategory": "APPLICATION_DOCUMENT"
}'
application/json
{
  "fileId": "fileId"
}