We refreshed our doc site!

Bookmarked links may have changed

Read release notes

getVerification

Get verification manifest

GEThttps://api.circle.com/verifications/{id}

Request servers to provide manifest of a verification submission.

Path parameters
id
string
Required

UUID created by verifier and returned from the initial call.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "body": {
4      "challenge": "64b3082b-ce23-4639-813d-33db3014ea89",
5      "presentation_definition": {
6        "format": {
7          "jwt": {
8            "alg": []
9          },
10          "jwt_vc": {
11            "alg": []
12          },
13          "jwt_vp": {
14            "alg": []
15          }
16        },
17        "id": "2fc73960-246b-40d6-98d6-946a085ca904",
18        "input_descriptors": [
19          {
20            "constraints": {
21              "fields": [
22                {
23                  "filter": {
24                    "pattern": "^did:web:issuer-sandbox.circle.com$|^did:key:zQ3shaWBKgKfo2yk2nncahcpXjdrKVxE2VB3CzEu2MhJwWcZX$|^did:web:assets.circle.com$",
25                    "type": "string"
26                  },
27                  "path": [],
28                  "predicate": "required",
29                  "purpose": "The process used for KYBP/AML."
30                }
31              ],
32              "is_holder": [
33                {
34                  "directive": "required",
35                  "field_id": []
36                }
37              ],
38              "statuses": {
39                "active": {
40                  "directive": "required"
41                },
42                "revoked": {
43                  "directive": "disallowed"
44                }
45              }
46            },
47            "id": "accinv_input",
48            "name": "Proof of Accredited Investor from Circle",
49            "purpose": "Please provide a valid credential from a Accredited Investor",
50            "schema": [
51              {
52                "required": false,
53                "uri": "https://raw.githubusercontent.com/centrehq/verite/d1b97b3a475aa00cf894f72213f34b7bcb8b3435/packages/docs/static/definitions/processes/kycaml/0.0.1/generic--usa-entity-accinv-all-checks\""
54              }
55            ]
56          }
57        ]
58      },
59      "status_url": "https://verifier-sandbox.circle.com/api/v1/verifications/2fc73960-246b-40d6-98d6-946a085ca904/status"
60    },
61    "created_time": "2022-10-26T05:09:39.375Z",
62    "expires_time": "2022-10-26T05:09:39.375Z",
63    "from": "did:web:circle.com",
64    "id": "2fc73960-246b-40d6-98d6-946a085ca904",
65    "reply_url": "https://verifier-sandbox.circle.com/api/v1/verifications/2fc73960-246b-40d6-98d6-946a085ca904",
66    "type": "https://circle.com/types/VerificationRequest"
67  }
68}
Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.