Retrieve a Database Verification

GET

https://withpersona.com/api/v1/verification/databases/:verification-id

GET

/api/v1/verification/databases/:verification-id

1 curl https://withpersona.com/api/v1/verification/databases/verification-id \
2      -H "Authorization: <apiKey>"

Try it

200Retrieved

1 {
2   "data": {
3     "type": "verification/database",
4     "id": "ver_1rWMmoV3hoy2qWv3wGPcH43c",
5     "attributes": {
6       "status": "passed",
7       "created-at": "2022-08-02T05:02:56.000Z",
8       "created-at-ts": 1659416576,
9       "submitted-at": "2022-08-02T05:03:02.000Z",
10       "submitted-at-ts": 1659416582,
11       "completed-at": "2022-08-02T05:03:02.000Z",
12       "completed-at-ts": 1659416582,
13       "country-code": "US",
14       "name-first": "ALEXANDER",
15       "name-middle": {},
16       "checks": [
17         {
18           "name": "database_inquiry_comparison",
19           "status": "not_applicable",
20           "reasons": [
21             "no_inquiry"
22           ],
23           "metadata": {}
24         },
25         {
26           "name": "database_address_deliverable_detection",
27           "status": "not_applicable",
28           "reasons": [
29             "disabled"
30           ],
31           "metadata": {}
32         },
33         {
34           "name": "database_address_residential_detection",
35           "status": "not_applicable",
36           "reasons": [
37             "disabled"
38           ],
39           "metadata": {}
40         },
41         {
42           "name": "database_po_box_detection",
43           "status": "passed",
44           "reasons": [],
45           "metadata": {}
46         },
47         {
48           "name": "database_deceased_detection",
49           "status": "passed",
50           "reasons": [],
51           "metadata": {}
52         },
53         {
54           "name": "database_identity_comparison",
55           "status": "passed",
56           "reasons": [],
57           "metadata": {
58             "check-requirements": [
59               {
60                 "name": "name_first",
61                 "match-result": "partial",
62                 "status": "passed",
63                 "comparisons": [
64                   {
65                     "type": "string_similarity",
66                     "match-level-minimum": "partial",
67                     "match-result": "partial"
68                   },
69                   {
70                     "type": "nickname",
71                     "match-level-minimum": "partial",
72                     "match-result": "none"
73                   },
74                   {
75                     "type": "string_difference",
76                     "match-level-minimum": "partial",
77                     "match-result": "none"
78                   },
79                   {
80                     "type": "substring",
81                     "match-level-minimum": "partial",
82                     "match-result": "partial"
83                   },
84                   {
85                     "type": "tokenization",
86                     "match-level-minimum": "partial",
87                     "match-result": "partial"
88                   }
89                 ]
90               },
91               {
92                 "name": "name_last",
93                 "match-result": "full",
94                 "status": "passed",
95                 "comparisons": [
96                   {
97                     "type": "string_similarity",
98                     "match-level-minimum": "partial",
99                     "match-result": "full"
100                   },
101                   {
102                     "type": "string_difference",
103                     "match-level-minimum": "partial",
104                     "match-result": "full"
105                   },
106                   {
107                     "type": "substring",
108                     "match-level-minimum": "partial",
109                     "match-result": "full"
110                   },
111                   {
112                     "type": "tokenization",
113                     "match-level-minimum": "partial",
114                     "match-result": "partial"
115                   }
116                 ]
117               },
118               {
119                 "name": "birthdate",
120                 "match-result": "full",
121                 "status": "passed",
122                 "comparisons": [
123                   {
124                     "type": "date_similarity",
125                     "match-level-minimum": "partial",
126                     "match-result": "full"
127                   }
128                 ]
129               },
130               {
131                 "name": "social_security_number",
132                 "match-result": "full",
133                 "status": "passed",
134                 "comparisons": [
135                   {
136                     "type": "string_similarity",
137                     "match-level-minimum": "full",
138                     "match-result": "full"
139                   }
140                 ]
141               },
142               {
143                 "name": "address_street_house_number",
144                 "match-result": "full",
145                 "status": "passed",
146                 "comparisons": [
147                   {
148                     "type": "string_difference",
149                     "match-level-minimum": "partial",
150                     "match-result": "full"
151                   }
152                 ]
153               },
154               {
155                 "name": "address_street_name",
156                 "match-result": "full",
157                 "status": "passed",
158                 "comparisons": [
159                   {
160                     "type": "string_similarity",
161                     "match-level-minimum": "partial",
162                     "match-result": "full"
163                   }
164                 ]
165               },
166               {
167                 "name": "address_street_type",
168                 "match-result": "full",
169                 "status": "passed",
170                 "comparisons": [
171                   {
172                     "type": "string_similarity",
173                     "match-level-minimum": "partial",
174                     "match-result": "full"
175                   }
176                 ]
177               },
178               {
179                 "name": "address_city",
180                 "match-result": "full",
181                 "status": "passed",
182                 "comparisons": [
183                   {
184                     "type": "string_similarity",
185                     "match-level-minimum": "partial",
186                     "match-result": "full"
187                   }
188                 ]
189               },
190               {
191                 "name": "address_subdivision",
192                 "match-result": "full",
193                 "status": "passed",
194                 "comparisons": [
195                   {
196                     "type": "string_difference",
197                     "match-level-minimum": "full",
198                     "match-result": "full"
199                   }
200                 ]
201               },
202               {
203                 "name": "address_postal_code",
204                 "match-result": "full",
205                 "status": "passed",
206                 "comparisons": [
207                   {
208                     "type": "string_difference",
209                     "match-level-minimum": "partial",
210                     "match-result": "full"
211                   }
212                 ]
213               },
214               {
215                 "name": "address_country_code",
216                 "match-result": "full",
217                 "status": "passed",
218                 "comparisons": [
219                   {
220                     "type": "string_difference",
221                     "match-level-minimum": "full",
222                     "match-result": "full"
223                   }
224                 ]
225               }
226             ]
227           }
228         }
229       ]
230     },
231     "relationships": {
232       "inquiry": {
233         "data": {}
234       }
235     }
236   }
237 }

Retrieve a database verification

Path parameters

verification-idstringRequired

ID of Verification to retrieve

Response

200

dataobject or null

Retrieve a Database Verification

Path parameters

Headers

Response

Errors