Requests
Requests are used to manage SDLT calculation requests for customers. They provide a way to create and track calculation requests before they are converted into actual calculations.
The request model
The request model contains all the information required to create a calculation request. It includes customer details, case reference, and request type information.
Properties
- Name
customer_email- Type
- string
- Description
The email of the client requesting the stamp calculation. Always required
- Name
customer_phone- Type
- string
- Description
The phone number of the client requesting the stamp calculation. Optional field
- Name
customer_first_name- Type
- string
- Description
The first name of the client requesting the stamp calculation. Always required
- Name
customer_last_name- Type
- string
- Description
The last name of the client requesting the stamp calculation. Always required
- Name
sender_email- Type
- string
- Description
The email address of the person or organization sending the request. Always required
- Name
sender_organization_name- Type
- string
- Description
The name of the organization sending the request. Always required
- Name
sender_first_name- Type
- string
- Description
The first name of the person sending the request. Always required
- Name
sender_last_name- Type
- string
- Description
The last name of the person sending the request. Always required
- Name
case_ref- Type
- string
- Description
The case reference number for the request. Always required
- Name
request_type- Type
- enum
- Description
The type of request. Must be one of: "SDLT_CALCULATION". Defaults to SDLT_CALCULATION. Optional field
- Name
property_value- Type
- integer
- Description
The value of the property in pounds. Optional field
- Name
notes- Type
- string
- Description
Internal notes for the request. Optional field
The request response
The response will contain the request details including customer information, case reference, and request status.
Properties
- Name
uuid- Type
- string
- Description
The unique ID of the request. This is a ShortUUID format identifier for the request record.
- Name
created_at- Type
- datetime
- Description
The date and time when the request was created. Format: YYYY-MM-DDTHH:MM:SS.
- Name
updated_at- Type
- datetime
- Description
The date and time when the request was last updated. Format: YYYY-MM-DDTHH:MM:SS.
- Name
customer_email- Type
- string
- Description
The email of the client requesting the stamp calculation. This is copied from the request data for reference.
- Name
customer_phone- Type
- string
- Description
The phone number of the client requesting the stamp calculation. This is copied from the request data for reference.
- Name
customer_first_name- Type
- string
- Description
The first name of the client requesting the stamp calculation. This is copied from the request data for reference.
- Name
customer_last_name- Type
- string
- Description
The last name of the client requesting the stamp calculation. This is copied from the request data for reference.
- Name
sender_email- Type
- string
- Description
The email address of the person or organization sending the request. This is copied from the request data for reference.
- Name
sender_organization_name- Type
- string
- Description
The name of the organization sending the request. This is copied from the request data for reference.
- Name
sender_first_name- Type
- string
- Description
The first name of the person sending the request. This is copied from the request data for reference.
- Name
sender_last_name- Type
- string
- Description
The last name of the person sending the request. This is copied from the request data for reference.
- Name
case_ref- Type
- string
- Description
The case reference number for the request. This is copied from the request data for reference.
- Name
request_type- Type
- string
- Description
The type of request. This is copied from the request data for reference.
- Name
property_value- Type
- integer
- Description
The value of the property in pounds. This is copied from the request data for reference.
- Name
notes- Type
- string
- Description
Internal notes for the request. This is copied from the request data for reference.
- Name
calculation_id- Type
- string
- Description
The unique ID of the calculation (if created). This will be null until a calculation is created from the request.
- Name
secret- Type
- string
- Description
The secret key for accessing the request. This is used to authenticate access to the request and its associated calculation.
- Name
request_url- Type
- string
- Description
The URL for accessing the request. This is the same URL that is sent in the request email to the customer.
Create a request
This endpoint allows you to create a new request. To create a request, you must authenticate with the Stamp Expert API using an OAuth2 token and provide the request details.
Required attributes
Please refer to the request model for the required and optional attributes.
Optional attributes
Some attributes are only required for certain scenarios. Please refer to the request model for the required and optional attributes.
Request
curl --request POST \
--url https://api.stamp.expert/v1/request \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/11.3.0' \
--data '{
"customer_email": "john.doe@example.com",
"customer_phone": "+447123456789",
"customer_first_name": "John",
"customer_last_name": "Doe",
"sender_email": "lawyer@lawfirm.com",
"sender_organization_name": "Smith & Associates",
"sender_first_name": "Jane",
"sender_last_name": "Smith",
"case_ref": "CASE123",
"request_type": "SDLT_CALCULATION",
"property_value": 500000,
"notes": "Test request for SDLT calculation"
}'
Response
{
"uuid": "req_V5577AWkcZ",
"created_at": "2025-07-16T06:35:51Z",
"updated_at": "2025-07-16T06:35:51Z",
"customer_email": "john.doe@example.com",
"customer_phone": "+447123456789",
"customer_first_name": "John",
"customer_last_name": "Doe",
"sender_email": "lawyer@lawfirm.com",
"sender_organization_name": "Smith & Associates",
"sender_first_name": "Jane",
"sender_last_name": "Smith",
"case_ref": "CASE123",
"request_type": "SDLT_CALCULATION",
"property_value": 500000,
"notes": "Test request for SDLT calculation",
"calculation_id": null,
"secret": "EEhTGRAzcCPHpbIYxdek4LQE0dvike99EOmBy4IaLg0",
"request_url": "https://app.stamp.expert/calculator/request/req_V5577AWkcZ?secret=EEhTGRAzcCPHpbIYxdek4LQE0dvike99EOmBy4IaLg0"
}
Retrieve a request
This endpoint allows you to retrieve a request by providing its unique identifier. Refer to the list at the top of this page to see which properties are included with request objects.
Request
curl https://api.stamp.expert/v1/request/req_c6noZZkYGB \
-H "Authorization: Bearer {token}"
Response
{
"uuid": "req_c6noZZkYGB",
"created_at": "2025-07-16T07:08:52",
"updated_at": "2025-07-16T07:08:52",
"customer_email": "john.doe@example.com",
"customer_phone": "+447123456789",
"customer_first_name": "John",
"customer_last_name": "Doe",
"sender_email": "lawyer@lawfirm.com",
"sender_organization_name": "Smith & Associates",
"sender_first_name": "Jane",
"sender_last_name": "Smith",
"case_ref": "CASE123",
"request_type": "SDLT_CALCULATION",
"property_value": 500000,
"notes": "Test request for SDLT calculation",
"calculation_id": null,
"secret": "EEhTGRAzcCPHpbIYxdek4LQE0dvike99EOmBy4IaLg0",
"request_url": "https://app.stamp.expert/calculator/request/req_c6noZZkYGB?secret=EEhTGRAzcCPHpbIYxdek4LQE0dvike99EOmBy4IaLg0"
}