Search
K
reporting v1

Retrieve Report

v1OAS 3.0

This API is used by Lenders & Law Firms to retrieve the reports

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:reports - Permission to view reports

Retrieve report

This API is used by Lenders & Law Firms to retrieve the reports

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/reports/{report_name}/content

Query Parameters

datestring

Report date must be in the format yyyy-mm-dd and must be less than 15 days old

Match pattern:^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$

Example:2019-05-17

Path Parameters

report_namestringrequired

Report name, must be one of:

  • report-financialsummary-todate
  • report-settlementhistory-daily
  • report-workspacesummary-todate

Example:report-financialsummary-todate

Response

application/octet-stream

OK

string
get/partner/api/platformconnect/v1/reports/{report_name}/content
 
application/octet-stream

X-API-Version

string

The API version that was used to process the request.