A person can have a number of DBS (Disclosure and Barring Service) certificates assigned to them. These end points enable the query and creation of a DBS certificate record against a person record
Get DBS by Person ID
Get DBS by Person ID
SecuritybearerAuth
Request
Responses
200
DBS Response
400
Bad Request
401
Unauthorized - Authorization Required
404
Not Found
422
Unprocessable Entity
default
General Error
get/dbs/{personId}
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- 400
- 401
- 404
- 422
- default
application/vnd.api+json
{- "links": {
}, - "data": {
- "0": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}, - "type": "dbs",
- "attributes": {
- "checkNumber": 123456789012
}, - "relationships": {
- "person": {
}
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}Add a DBS record
Add a DBS record to a person
SecuritybearerAuth
Request
Request Body schema: application/vnd.api+json
DBS to be added
object |
Responses
200
DBS Response
400
Bad Request
401
Unauthorized - Authorization Required
422
Unprocessable Entity
default
General Error
post/dbs
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "dbs",
- "attributes": {
- "checkNumber": 123456789012
}, - "relationships": {
- "0": null,
- "person": {
- "data": {
- "id": "285f0a36-9ff3-4399-a47a-80e9bce56921",
- "type": "people"
}
}
}
}
}Response samples
- 200
- 400
- 401
- 422
- default
application/vnd.api+json
{- "links": {
}, - "data": {
- "0": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}, - "type": "dbs",
- "attributes": {
- "checkNumber": 123456789012
}, - "relationships": {
- "person": {
}
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}