Retrieve a Serpro Database Verification

GET

https://api.withpersona.com/api/v1/verification/database-serpros/:verification-id

GET

/api/v1/verification/database-serpros/:verification-id

$ curl https://api.withpersona.com/api/v1/verification/database-serpros/verification-id \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "ver_ixBrVPK2jKwg4qGmbWZvwMmw",
4     "attributes": {
5       "birthdate": "1994-12-30",
6       "checks": [],
7       "completed-at": null,
8       "completed-at-ts": null,
9       "country-code": "BR",
10       "cpf": "123456789",
11       "created-at": "2022-08-03T03:42:20.000Z",
12       "created-at-ts": 1659498140,
13       "name-first": "Jane",
14       "name-full": "Jane Doe",
15       "name-last": "Doe",
16       "status": "initiated",
17       "submitted-at": null,
18       "submitted-at-ts": null
19     },
20     "relationships": {
21       "inquiry": {
22         "data": null
23       },
24       "inquiry-template": {
25         "data": null
26       },
27       "inquiry-template-version": {
28         "data": null
29       },
30       "selfie": {
31         "data": {
32           "id": "self_ABC123",
33           "type": "selfie/profile-and-center"
34         }
35       },
36       "template": {
37         "data": null
38       },
39       "transaction": {
40         "data": null
41       },
42       "verification-template": {
43         "data": {
44           "type": "verification-template/database-serpro",
45           "id": "vtmpl_ABC123"
46         }
47       },
48       "verification-template-version": {
49         "data": {
50           "type": "verification-template-version/database-serpro",
51           "id": "vtmplv_ABC123"
52         }
53       }
54     },
55     "type": "verification/database-serpro"
56   }
57 }

Retrieve a Serpro database verification

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

verification-idstringRequired

ID of Verification to retrieve

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Response headers

RateLimit-Limitinteger

The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Resetinteger

The number of seconds until the current rate limit window resets. Returned on every authenticated response.

Request-Idstring

The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.

Persona-Environment-Idstring

The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.

Persona-Organization-Idstring

The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.

Response

This endpoint returns a Serpro Database Verification object and (optionally) its related objects in included.

dataobject

A Serpro Database Verification

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error