Appearance
API Changelog
August 14 2023
- Updated Delete an assignee for a client endpoint
- Added
401
response - Added
404
response - Updated query parameter descriptions
- Added
- Updated List all assignees for a client endpoint
- Added
401
response - Added
404
response - Updated description
- Added
- Updated Set assignees for a client endpoint
- Added
401
response - Added
404
response - Added
422
response - Updated query parameter descriptions
- Added
- Updated Update assignees for a client endpoint
- Added
401
response - Added
404
response - Added
422
response - Updated query parameter descriptions
- Added
- Updated Delete assignees for a client endpoint
- Added
401
response - Added
404
response
- Added
August 9 2023
- Added
address
object property descriptions - Updated Retrieve address for a client endpoint
- Added
401
response - Added
404
response - Updated description
- Added
- Updated Replace an address for a client endpoint
- Added
401
response - Added
404
response - Added
422
response - Updated description
- Added
August 3 2023
- Added
client
object property descriptions - Updated List all clients endpoint
- Added
401
response - Updated description
- Added
- Updated Create a client endpoint
- Added
401
response - Added
422
response - Updated description
- Added
- Updated Retrieve a client endpoint
- Added
401
response - Added
404
response - Updated description
- Added
- Updated Update a client endpoint
- Added
401
response - Added
404
response - Added
422
response - Updated description
- Added
August 2 2023
- Deprecated Archive a record endpoint. Replaced by Update a record endpoint.
July 31 2023
- Added
perform_link
torecord
object
July 26 2023
- Added
is_reviewed
property to Update a record endpoint. Allows toggling a record's reviewed state.
July 21 2023
- Added Update a record endpoint
July 14 2023
- Updated List all records endpoint
- Added
page
,limit
,status
,creator
andassignee
query parameters
- Added
July 6 2023
- Updated Delete organisation for a client endpoint
- Added
401
response - Added
404
response
- Added
- Updated Delete organisations for a client endpoint
- Added
401
response - Added
404
response
- Added
- Updated List all organisations for a client endpoint
- Added
401
response - Added
404
response - Updated description
- Added
- Updated Update organisations for a client endpoint
- Added
404
response - Updated description
- Added
- Updated Replace organisations for a client endpoint
- Added
401
response - Added
404
response
- Added
July 4 2023
- Updated Create an organisation and Update an organisation properties
- Updated
jurisdiction
description with details of requirement
- Updated
- Added request code samples
June 28 2023
- Added
template
property to Create a record endpoint. Allows creation of records using a record template.
June 26 2023
- Added
expand
query parameter examples for List all steps for a record endpoint
June 20 2023
- Added Create an attachment endpoint
June 13 2023
- Added
organisation
object property descriptions - Updated Retrieve all organisations endpoint
- Added
401
response - Updated description
- Added
- Updated Create an organisation endpoint
- Added
401
response - Added
422
response - Updated description
- Added
- Updated Retrieve an organisation endpoint
- Added
401
response - Added
404
response
- Added
- Updated Update an organisation endpoint
- Added
401
response - Added
404
response - Added
422
response - Updated description
- Added
June 1 2023
- Added
status
enum values to Create a client and Update a client endpoints - Added
user
object property descriptions - Updated
422 Unprocessable Content
response description with examples - Updated Check service status endpoint
- Removed
403
response - Added
401
response - Updated description
- Removed
- Updated Retrieve user account endpoint
- Added
401
response - Updated description
- Added
- Updated Update user account endpoint
- Added
401
response - Added
422
response - Updated description
- Added
- Updated List all my teams endpoint
- Added
401
response - Updated description
- Added
- Updated Retrieve team membership endpoint
- Added
401
response - Updated description
- Added
- Updated Retrieve a team member endpoint
- Added
401
response
- Added
May 31 2023
- Changed
403
responses- Updated response from
403 Unauthorized
to403 Forbidden
- Removed
error
property - Added
message
property
- Updated response from
May 29 2023
- Added
secret
property towebhook
object - Added
201 Created
success responses to Update assignees for a record and Update assignees for a client endpoints
May 26 2023
⚠️ Breaking changes
This release includes breaking changes.
- Changed Document Transfer record step preferences
- Added required
attachment
property to "New Document" type
- Added required
May 22 2023
- Changed HSCNI Access NI record step preferences
- Updated
barring_adults
andbarring_children
description with details of requirement - Changed
false
as default value forbarring_adults
andbarring_children
properties
- Updated
- Changed Watchlist record step preferences
- Changed
true
as default value forsilent
property - Updated
silent
description with details of availability
- Changed
May 18 2023
⚠️ Breaking changes
This release includes breaking changes.
- Changed Dummy record step preferences
preferences
is no longer a required property- Changed
payment_amount
fromfloat
tointeger
- Updated
payment_amount
description with details of value format - Changed minimum and maximum value of
payment_amount
to0
–10000
- Changed minimum and maximum value of
credit_cost
to0
–100
May 17 2023
⚠️ Breaking changes
This release includes breaking changes.
- Changed Banking Information record step preferences
- Renamed step type
check.open_banking
tocheck.banking_information
preferences
is no longer a required property- Added
false
as default value forbalance
andtransactions
properties
- Renamed step type
- Changed Criminal Record step preferences
free_volunteer
property for DBS: Standard and DBS: Enhanced types is now read only
- Changed Document Transfer step preferences
- Renamed property
confirmed
torequire_confirmation
- Renamed property
returned
torequire_return
- Renamed property
- Changed Photo ID step preferences
face
andliveness
properties forstandard
report type are now read only- Added
issuing_countries
property forstandard
andbiometric
report types - Updated
facial_similarity
description forstandard
report type with details of cost changes
- Changed Photo ID step preferences
- Added
1
and3
options tomonitor
property - Added
false
as default value forsilent
andmonitor
properties - Updated
silent
andmonitor
descriptions with details of availability and cost changes
- Added
- Changed
record_document
object- Renamed config choice headings
- "Sent" to "Document Transfer"
- "Requested" to "Document Request"
- Renamed property
description
toinstructions
- Renamed property
instructions
toreturn_message
- Added
return_message
description
- Renamed config choice headings
- Removed
link
andin_person
notification types from Create a record endpoint - Added
false
notification type to Create a record endpoint
May 12 2023
⚠️ Breaking changes
This release includes breaking changes.
- Changed success response codes from
200 OK
to201 Created
for endpoints:- Create a client
- Set assignees for a client
- Create an organisation
- Create a record
- Set assignees for a record
- Create a webhook
May 11 2023
- Changed maximum length of
message
property to5000
for Create a record endpoint
May 10 2023
- Removed
enabled
query parameter from List all forms for a client endpoint