Search
K
lodgement v1

Lodgement

v1.1.0OAS 3.0

This API product gives all the possible functionalities we can perform on lodgement like case summary, document upload/download, and application attribute updates

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • x-api:view:lodgement_summary - Read access to the lodgement summary
  • x-api:edit:lodgement_applications - Edit access to the lodgement applications
  • x-api:create:attachments - Create access to the attachments
  • x-api:add:workspace_files - Add access to the workspace files
  • view:title_documents - View access to the title documents
  • x-api:view:documents - View access to the documents
  • x-api:approve:lodgement_applications - Approve access to lodgement applications
  • x-api:unapprove:lodgement_applications - Unapprove access to lodgement applications
  • x-api:submit:lodgement_applications - Submit access to lodgement applications
  • x-api:add:lodgement_titles - Add titles to lodgementCase
  • view:lodgement_cases - View lodgement cases
  • view:lodgement_documents - View lodgement documents
  • view:lodgement_titles - View lodgement titles
  • edit:lodgement_documents - Edit access to the lodgement documents
  • add:lodgement_files - Add access to the lodgement files
  • view:lodgement_files - View access to the lodgement files
  • submit:lodgement_applications - Submit access to the lodgement applications
  • view:workspaces - View access to the workspaces

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
 
application/json

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
 
application/octet-stream

Submit Lodgement Case to HMLR

This API is used to manually submit a lodgement case to HMLR for processing. This triggers the submission workflow for the specified lodgement case.

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

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

NO CONTENT - Lodgement case submitted successfully

post/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/submit
 

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

{}
 
application/json