Download OpenAPI specification:Download
V0.1 of the set of APIs for the new Validating Customer Application Data RESTful API Schema
Accept order submission requests for processing
required | object (SubstantiveOrderData) |
{- "data": {
- "addresses": [
- {
- "reference": "property address",
- "details": {
- "type": "UK",
- "care_of_name": "string",
- "full_address": "string",
- "number": "string",
- "service_number_rank": "string",
- "unit_regiment": "string"
}
}
], - "ap1_warning_understood": true,
- "applicants": [
- {
- "party_reference": "customer"
}
], - "bypass_validation": [
- {
- "validation_type": "string",
- "validation_pointer": "string",
- "reason": "DISAGREE_WITH_REGISTER",
- "comment": "string"
}
], - "customer_reference": "string",
- "documents": [
- {
- "reference": "signed_charge",
- "document_id": "string",
- "document_metadata": {
- "certification_statement_type": "CERTIFIED",
- "document_filename": "string"
}, - "type": "ABSTRACT"
}
], - "jp1_reference": "string",
- "order_lodger": {
- "email": {
- "type": "UK",
- "email": "string",
- "full_address": "string"
}, - "telephone": "string",
- "type": "CONVEYANCER"
}, - "parties": [
- {
- "address_for_service_option": "PROPERTY_ADDRESS",
- "addresses": [
- "property address"
], - "company_number": "string",
- "forenames": "string",
- "freeformat_name": "string",
- "identity_evidence_type": "EVIDENCE",
- "incorporation_territory": "string",
- "organisation_name": "string",
- "other_conveyancer": {
- "conveyancer_reference": "string",
- "full_name": "string",
- "registered_address": "string"
}, - "reference": "customer",
- "register_action": "AMEND",
- "representation_type": "LODGING_CONVEYANCER",
- "surname": "string",
- "type": "PRIVATE_INDIVIDUAL"
}
], - "titles": [
- {
- "disclosable_overriding_interests": true,
- "scope_details": {
- "part_description": "string",
- "scope": "WHOLE"
}, - "title_number": "string",
- "title_type": "REGISTER_TITLE"
}
], - "transactions": [
- {
- "reference": "property charge",
- "details": {
- "type": "string",
- "value": 0,
- "value_band": {
- "lower_value_band": 1,
- "upper_value_band": 100000
}, - "full_value_of_property_band": {
- "lower_value_band": 1,
- "upper_value_band": 100000
}, - "full_value_of_property": 0,
- "outstanding_charge": 0
}, - "documents": [
- "signed_charge"
], - "party_roles": [
- {
- "capacity": "REGISTERED_PROPRIETOR",
- "party_reference": "customer",
- "role": "ATTORNEY"
}
], - "type": "ADV1",
- "title_references": [
- "string"
]
}
], - "type": "REGISTER_UPDATE",
- "additional_provider_filter": "string",
- "vdd_account_number": "string"
}
}{- "order_request_id": "string"
}Retrieve a generated document upload URL
required | object (DocumentUploadUrlData) |
{- "data": {
- "document_type": "ACKAPU",
- "additional_provider_filter": "string"
}
}{- "upload_url": "string",
- "document_id": "string"
}Get status of an order submission request.
| order_request_id required | string The ID returned by the Order Submission request API |
{- "errors": [
- {
- "type": "L2_MDREF_ERROR",
- "summary": "MDRef validation Failed",
- "detail": "The MDref included in the request does not exist",
- "pointer": "#/data/transaction/0/mdref"
}
], - "hmlr_reference": "string",
- "priority_timestamp": "2019-08-24T14:15:22Z",
- "order_request_id": "string",
- "status": "PENDING",
- "calculated_fees": {
- "total_fee": 0,
- "per_transaction": [
- {
- "transaction_reference": "property charge",
- "fee": 0
}
]
}
}