Help CenterOpenAPI SpecStatus
DocumentationAPI ReferenceChangelogIntegration Guides
DocumentationAPI ReferenceChangelogIntegration Guides
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Idempotence
    • Pagination
    • Serialization
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • POSTResume an Inquiry
    • GETRetrieve an Inquiry
    • DELRedact an Inquiry
    • PATCHUpdate an Inquiry
    • GETRetrieve a Report
    • DELRedact a Report
    • GETRetrieve a Verification
    • POSTDecline an Inquiry
    • POSTApprove an Inquiry
    • GETList all Inquiries
    • POSTCreate an Inquiry
    • GETRetrieve an Account
    • DELRedact an Account
    • PATCHUpdate an Account
    • GETList all Accounts
    • POSTCreate an Account
    • GETDownload a File
    • GETList all API Logs
    • POSTCreate a Generic Document
    • GETRetrieve an API Log
    • GETRetrieve a Document
    • POSTCreate a Phone Number Verification
    • PATCHUpdate a Generic Document
    • POSTCreate a Document Verification
    • POSTSubmit a Generic Document
    • GETList all Events
    • POSTCreate a Government ID Verification
    • POSTCreate a Database Verification
    • POSTSubmit a Document Verification
    • GETRetrieve a Document Verification
    • GETRetrieve an Event
    • POSTImport Accounts
    • GETRetrieve an Importer
    • POSTConsolidate Accounts
    • POSTImport Geolocation Lists
    • POSTImport Email Address Lists
    • POSTImport Government ID Number Lists
    • POSTImport Name Lists
    • POSTImport IP Address Lists
    • POSTCreate a Government ID Document
    • POSTImport Phone Number Lists
    • PATCHUpdate a Government ID Document
    • POSTSubmit a Government ID Document
    • POSTSubmit a Government ID Verification
    • PATCHUpdate a Government ID Verification
    • GETList all Lists
    • GETRetrieve a List
    • DELArchive a List
    • POSTCreate a Browser Fingerprint List
    • POSTCreate a Geolocation List
    • POSTCreate an Email Address List
    • POSTCreate a Browser Fingerprint List Item
    • POSTCreate a Country List
    • POSTCreate an IP Address List
    • POSTCreate a Phone Number List
    • POSTCreate a Government ID Number List
    • POSTCreate a Name List
    • POSTCreate a Country List Item
    • POSTCreate an Email Address List Item
    • POSTCreate a Phone Number List Item
    • DELArchive a Browser Fingerprint List Item
    • POSTCreate an IP Address List Item
    • POSTCreate a Geolocation List Item
    • POSTCreate a Government ID Number List Item
    • DELArchive an IP Address List Item
    • DELArchive a Government ID Number List Item
    • DELArchive a Name List Item
    • DELArchive an Email Address List Item
    • DELArchive a Country List Item
    • DELArchive a Geolocation List Item
    • POSTCreate a Name List Item
    • DELArchive a Phone Number List Item
    • GETList all Reports
    • POSTCreate a Report
    • GETList all Cases
    • POSTCreate a Case
    • POSTCreate a Selfie Verification
    • POSTSubmit a Selfie Verification
    • GETRetrieve Case
    • PATCHUpdate a Case
    • POSTRemove a tag
    • POSTSet all tags
    • POSTAdd a tag
    • POSTSet all tags
    • POSTAdd a tag
    • POSTRemove a tag
    • GETPrint Inquiry PDF
    • GETPrint Verification PDF
    • GETPrint Report PDF
    • POSTReport a Government ID Verification
    • POSTBusiness Lookup Report
    • POSTAdd Persona objects
    • POSTAssign a Case
    • POSTCreate a Face List Item
    • POSTCreate a Face List
    • DELArchive a Face List Item
    • POSTImport Face Lists
    • POSTAdd a tag
    • POSTRemove a tag
    • POSTSet all tags
    • GETList all User Audit Logs
    • GETRetrieve an User Audit Log
    • POSTSet status for a case
    • GETRetrieve a Government Id Verification
    • GETRetrieve a Selfie Verification
    • POSTSubmit a Database Verification
    • GETRetrieve a Database Verification
    • POSTCreate a Phone Carrier Database Verification
    • POSTSubmit a Phone Carrier Database Verification
    • GETRetrieve a Phone Carrier Database Verification
    • POSTCreate a Serpro Database Verification
    • POSTSubmit a Serpro Database Verification
    • GETRetrieve a Serpro Database Verification
    • POSTCreate a TIN Database Verification
    • POSTSubmit a TIN Database Verification
    • GETRetrieve a TIN Database Verification
    • POSTConfirm a Phone Number Verification
    • GETRetrieve a Phone Number Verification
    • POSTSend an SMS
    • POSTCreate a Workflow Run
    • POSTCreate an Email Address Verification
    • POSTSend an email
    • POSTConfirm an Email Address Verification
    • GETRetrieve a Email Address Verification
    • GETList all API keys
    • POSTCreate an API key
    • POSTExpire an API key
    • GETRetrieve an API key
    • PATCHUpdate an API key
    • POSTAdd a tag
    • POSTRemove a tag
    • POSTSet all tags
LogoLogo
Help CenterOpenAPI SpecStatus

GET
https://withpersona.com/api/v1/cases/:case-id
GET
/api/v1/cases/:case-id
1curl https://withpersona.com/api/v1/cases/case-id \
2 -H "Authorization: <apiKey>"
Try it
1{
2 "data": {
3 "type": "case",
4 "id": "case_KsFU1Vxv9oK3ztnwQuD7MaJo",
5 "attributes": {
6 "status": "open",
7 "name": "KCAS-1",
8 "resolution": {},
9 "created-at": "2021-03-24T04:59:21.764Z",
10 "updated-at": "2021-03-24T04:59:21.764Z",
11 "assigned-at": {},
12 "creator-id": {},
13 "creator-type": {},
14 "assignee-id": {},
15 "resolver-id": {},
16 "resolver-type": {},
17 "updater-id": {},
18 "updater-type": {},
19 "tags": []
20 },
21 "relationships": {
22 "case-template": {
23 "data": {
24 "type": "case-template",
25 "id": "ctmpl_336jV1uVaaY84GAqvG91oiy9"
26 }
27 },
28 "case-comments": {
29 "data": [
30 {
31 "type": "case-comment",
32 "id": "cscm_yd2urRmjaCWcSSxqTSHvUcsn"
33 }
34 ]
35 },
36 "accounts": {
37 "data": [
38 {
39 "type": "account",
40 "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ"
41 }
42 ]
43 },
44 "inquiries": {
45 "data": [
46 {
47 "type": "inquiry",
48 "id": "inq_b6UPkf7mNC1qBtLXnfaWyUbY"
49 }
50 ]
51 },
52 "reports": {
53 "data": []
54 }
55 }
56 },
57 "included": [
58 {
59 "type": "account",
60 "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ",
61 "attributes": {
62 "reference-id": {},
63 "created-at": "2021-03-24T04:59:06.000Z",
64 "updated-at": "2021-03-24T04:59:06.000Z",
65 "tags": []
66 }
67 },
68 {
69 "type": "inquiry",
70 "id": "inq_b6UPkf7mNC1qBtLXnfaWyUbY",
71 "attributes": {
72 "reference-id": {},
73 "created-at": "2021-03-24T04:59:06.000Z",
74 "tags": [],
75 "status": "created",
76 "note": {},
77 "reviewer": {},
78 "reviewer-type": {},
79 "reviewer-comment": {},
80 "started-at": {},
81 "completed-at": {},
82 "failed-at": {},
83 "decisioned-at": {},
84 "expired-at": {}
85 },
86 "relationships": {
87 "account": {
88 "data": {
89 "type": "account",
90 "id": "act_RNwaSKFUDTzxUakAEuE2xmhZ"
91 }
92 },
93 "template": {
94 "data": {
95 "type": "template",
96 "id": "blu_biqYXr3aNfHuLeXUdJUNFNET"
97 }
98 },
99 "reports": {
100 "data": []
101 },
102 "verifications": {
103 "data": []
104 },
105 "sessions": {
106 "data": []
107 },
108 "documents": {
109 "data": []
110 },
111 "selfies": {
112 "data": []
113 }
114 }
115 },
116 {
117 "type": "case-comment",
118 "id": "cscm_yd2urRmjaCWcSSxqTSHvUcsn",
119 "attributes": {
120 "created-at": "2021-03-25T07:04:16.667Z",
121 "updated-at": "2021-03-25T07:04:16.667Z",
122 "message": "This is a case comment",
123 "commenter-id": "admin@acme.com",
124 "commenter-type": "user"
125 }
126 }
127 ]
128}
Was this page helpful?
Previous

Update a Case

Next
Built with
Retrieves the details of a <<glossary:case>> that has previously been created.
Retrieve Case

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

case-idstringRequired

Headers

key-inflectionstringOptional
Determines casing for the API response

Response

200
dataobject or null
includedlist of objects or null

Errors

Retrieves the details of a <<glossary:case>> that has previously been created.