Scope Request Types

Civic Developer Resources
Search…
Civic Pass Overview
How it works
Requesting Access
On-chain Integration
UI integration: React component
Legacy APIs (SIP)
Front-End Event Types
Errors
Questions? Find us on Discord
Scope Request Types
BASIC_SIGNUP
The BASIC_SIGNUP scope request returns the user’s basic account info - email and phone. It is most commonly used for secure login and signup solutions when no additional identity verification is required.
1
 civicSip.signup({
2
   style: 'popup',
3
   scopeRequest: civicSip.ScopeRequests.BASIC_SIGNUP
4
 });
Copied!
​
USER DATA RETURNED
Label
Example Value
Description
contact.personal.email
[email protected]
The user's verified email.
isValid
true
Civic SIP service checks whether or not the data is still considered valid on the blockchain.
isOwner
true
Civic SIP service challenges the user during scope request approval to ensure the user is in control of the private key originally used in the issuance of the data attestation.
userId
c6d5795...b42
Anonymous user identifier
​
JSON EXAMPLE
1
userData =  {
2
    "data": [
3
        {
4
            "label": "contact.personal.email",
5
            "value": "[email protected]",
6
            "isValid": true,
7
            "isOwner": true
8
        },
9
        {
10
            "label": "contact.personal.phoneNumber",
11
            "value": "+1 5551234567",
12
            "isValid": true,
13
            "isOwner": true
14
        }
15
    ],
16
    "userId": "c6d5795f8a059ez5ad29a33a60f8b402a172c3e0bbe50fd230ae8e0303609b42"
17
}
Copied!
PROOF_OF_IDENTITY
The PROOF_OF_IDENTITY scope request returns the full set of verified information for a user’s identity check.
1
 civicSip.signup({
2
     style: 'popup',
3
     scopeRequest: civicSip.ScopeRequests.PROOF_OF_IDENTITY
4
  });
Copied!
Intro Step
For PROOF_OF_IDENTITY scope requests, we display an intro screen that helps users understand the verification process steps:
Desktop View
Mobile Web View
If you would like to provide your own context within your application, this screen can be skipped by setting hideIntro: true when you initialize the front-end library to display the QR Code directly:
1
  // Instantiate instance of civic.sip
2
  var civicSip = new civic.sip({
3
    appId: 'ABC123',
4
    // OPTIONAL configuration
5
    hideIntro: true, // set to true to override intro screen (Proof of Identity only)
6
  });
Copied!
Note that attempting this request without prior approval will return an unauthorized error. You can request access via the Civic Integration Portal.
USER DATA RETURNED
Label
Example Value
Description
documents.genericId.type
passport
Type of ID document provided for KYC verification.
documents.genericId.number
ABC1112223333
ID string (such as Driver's License or Passport number) for the document provided.
documents.genericId.name
John Peter Smith
Name given on the ID document
documents.genericId.dateOfBirth
1980-01-30
Data of birth given on the ID document in YYYY-MM-DD format.
documents.genericId.dateOfIssue
2015-06-15
Issued date of the ID document in YYYY-MM-DD format.
documents.genericId.dateOfExpiry
2021-1-01
Expiry date of the ID document in YYYY-MM-DD format.
documents.genericId.image
/9j/4AA[...]
base64 encoded image of the ID document.
documents.genericId.image_md5
81ece061fd53c479f1f7a0cdfb5d3cf1
md5 hash of the image.
documents.genericId.country
USA
Issuing country of the ID document.
contact.personal.email
[email protected]
User's verified email address.
verifications.levels.CIVIC:IAL1
CIVIC:IAL1
Verification standard used to check the document. This field should be ignored pending future functionality.
JSON EXAMPLE
1
{
2
    "data": [
3
      {
4
        "label": "verifications.levels.CIVIC:IAL1",
5
        "value": "CIVIC:IAL1",
6
        "isValid": true,
7
        "isOwner": true
8
      },
9
      {
10
        "label": "documents.genericId.type",
11
        "value": "Driving License",
12
        "isValid": true,
13
        "isOwner": true
14
      },
15
      {
16
        "label": "documents.genericId.number",
17
        "value": "A0000000",
18
        "isValid": true,
19
        "isOwner": true
20
      },
21
      {
22
        "label": "documents.genericId.name",
23
        "value": "Jane Doe",
24
        "isValid": true,
25
        "isOwner": true
26
      },
27
      {
28
        "label": "documents.genericId.dateOfBirth",
29
        "value": "YYYY-m-d",
30
        "isValid": true,
31
        "isOwner": true
32
      },
33
      {
34
        "label": "documents.genericId.dateOfIssue",
35
        "value": "YYYY-m-d",
36
        "isValid": true,
37
        "isOwner": true
38
      },
39
      {
40
        "label": "documents.genericId.dateOfExpiry",
41
        "value": "2021-1-01",
42
        "isValid": true,
43
        "isOwner": true
44
      },
45
      {
46
        "label": "documents.genericId.image",
47
        "value": "/9j/4AA...",
48
        "isValid": true,
49
        "isOwner": true
50
      },
51
      {
52
        "label": "documents.genericId.image_md5",
53
        "value": "d0a...",
54
        "isValid": true,
55
        "isOwner": true
56
      },
57
      {
58
        "label": "documents.genericId.country",
59
        "value": "USA",
60
        "isValid": true,
61
        "isOwner": true
62
      }
63
      {
64
        "label": "contact.personal.email",
65
        "value": "[email protected]",
66
        "isValid": true,
67
        "isOwner": true
68
     }
69
    ],
70
    "userId": "c6d5795f8a059ez5ad29a33a60f8b402a172c3e0bbe50fd230ae8e0303609b42"
71
}
Copied!
RESPONSE OBJECTS
Possible values for specific fields.

Note: The documents.genericId.type values listed are not exhaustive. It depends on the user's document type when they verified on their Civic Mobile App. This table lists the common values.
Label
Possible Values
documents.genericId.type
Passport
Driving License
Visa
ID Card
Biometric Residence Permit
Voter ID
documents.genericId.country
Three letter ISO code: ALPHA-3 Standard eg: USA
Step-by-step guide
Front-End Event Types
Last modified 10d ago
Copy link
Contents
BASIC_SIGNUP
PROOF_OF_IDENTITY