Appearance
Authorization
All requests to the API must be authenticated with an API key or OAuth2 access token.
Authorization using API key
You can view your API key in your account dashboard.
To authorize API calls using an API key, include an Authorization
HTTP header with your API key in every request:
bash
Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0
1
Authorization using OAuth2 Client Credentials flow
Your OAuth2 client_id
is your account ID. You can view your account ID and OAuth2 client_secret
in your account dashboard.
Obtain an OAuth2 access token using the Client Credentials flow as specified in RFC6749:
bash
curl -X POST "https://auth.godiddy.com/1.0.0/oauth2/token" \
-H "Authorization: Basic YjA4MmM0MjAtZGY2Ny00YjA2LTg5OWMtYjdjNTFkNzVmYmEwOm5ocWZpdW93ZW5maHVhc2RuZmJhc2hkZmJ1cXp3ZWJy" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'grant_type=client_credentials'
1
2
3
4
2
3
4
Response:
json
{
"access_token": "wenrkjqwnerkbber",
"token_type": "Bearer",
"scope": "*"
}
1
2
3
4
5
2
3
4
5
To authorize API calls using an OAuth2 access token, include an Authorization
HTTP header with your access token in every request:
bash
Authorization: Bearer wenrkjqwnerkbber
1
Universal Resolver Examples
See Universal Resolver for more information and examples about the Universal Resolver component of Godiddy.
Resolve a DID (full DID resolution result)
bash
curl -X GET "https://api.godiddy.com/1.0.0/universal-resolver/identifiers/did:key:z6Mkto1GQWLnh2XKCA1JPrxjL4DrKvBPdf5N17ueNs3NJWGu" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0"
1
2
2
Resolve a DID (only DID document)
bash
curl -X GET "https://api.godiddy.com/1.0.0/universal-resolver/identifiers/did:key:z6Mkto1GQWLnh2XKCA1JPrxjL4DrKvBPdf5N17ueNs3NJWGu" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Accept: application/did"
1
2
3
2
3
Universal Registrar Examples
See Universal Registrar for more information and examples about the Universal Resolver component of Godiddy.
Create a DID (did:key)
bash
curl -X POST "https://api.godiddy.com/1.0.0/universal-registrar/create?method=key" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Content-Type: application/json" \
-d '{ "didDocument": { }, "options": { "keyType": "ed25519" }, "secret": { } }'
1
2
3
4
2
3
4
Create a DID (did:jwk)
bash
curl -X POST "https://api.godiddy.com/1.0.0/universal-registrar/create?method=jwk" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Content-Type: application/json" \
-d '{ "didDocument": { }, "options": { "keyType": "ed25519" }, "secret": { } }'
1
2
3
4
2
3
4
Create a DID (did:indy)
bash
curl -X POST "https://api.godiddy.com/1.0.0/universal-registrar/create?method=indy" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Content-Type: application/json" \
-d '{ "didDocument": { }, "options": { "network": "danube" }, "secret": { } }'
1
2
3
4
2
3
4
Wallet Service Examples
See Wallet Service for more information and examples about the Wallet Service component of Godiddy.
Get DIDs from wallet
bash
curl -X GET "https://api.godiddy.com/1.0.0/wallet-service/controllers" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Accept: application/json"
1
2
3
2
3
Get keys from the wallet
bash
curl -X GET "https://api.godiddy.com/1.0.0/wallet-service/keys" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Accept: application/json"
1
2
3
2
3
Version Service Examples
See Version Service for more information and examples about the Version Service component of Godiddy.
Get the latest DID in a DID method
bash
curl -X GET "https://api.godiddy.com/1.0.0/version-service/didrecords?method=indy&limit=5" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Accept: application/json"
1
2
3
2
3
Resolve a DID at a specific point in time
bash
curl -X GET "https://api.godiddy.com/1.0.0/version-service/didrecords?did=did:indy:idunion:test:BDrEcHc8Tb4Lb2VyQZWEDE&versionTime=1602854361000" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Accept: application/json"
1
2
3
2
3
Universal Issuer Examples
See Universal Issuer for more information and examples about the Universal Issuer component of Godiddy.
Issue a VC via Universal Issuer (JSON-LD)
bash
curl -X POST "https://api.godiddy.com/1.0.0/universal-issuer/credentials/issue" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Content-Type: application/json" \
-d '{
"credential": {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://essif.europa.eu/schemas/vc/2020/v1"
],
"type": [
"VerifiableCredential",
"VerifiableAttestation",
"DiplomaCredential"
],
"issuer": "did:key:z6MkpMuEMxTKFnNugkZBa5YDtrwNaDun2HjSMiQNeUxsEB24",
"credentialSubject": {
"type": "Student",
"id": "did:key:z6MkqyYXcBQZ5hZ9BFHBiVnmrZ1C1HCpesgZQoTdgjLdU6Ah",
"studyProgram": "Master Studies in Computer Science",
"learningAchievement": "Master of Science",
"dateOfAchievement": "2021-03-18T00:00:00.000Z",
"eqfLevel": "http://data.europa.eu/snb/eqf/7"
}
},
"options": {
"format": "jsonld",
"type": "Ed25519Signature2020",
"returnMetadata": false,
"credentialFormatOptions": {
"documentLoaderEnableHttps": true
}
}
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Universal Verifier Examples
See Universal Verifier for more information and examples about the Universal Verifier component of Godiddy.
Verify a VC via Universal Verifier (JSON-LD)
bash
curl -X POST "https://api.godiddy.com/1.0.0/universal-verifier/credentials/verify" \
-H "Authorization: Bearer b082c420-df67-4b06-899c-b7c51d75fba0" \
-H "Content-Type: application/json" \
-d '{
"verifiableCredential": {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://essif.europa.eu/schemas/vc/2020/v1",
"https://w3id.org/security/suites/ed25519-2020/v1"
],
"type": [
"VerifiableCredential",
"VerifiableAttestation",
"DiplomaCredential"
],
"issuer": "did:key:z6MkrBLbiyN7pDuoK6esPDQas7FYeueVVAKz8ZtMaMcFpDE2",
"credentialSubject": {
"type": "Student",
"id": "did:key:z6MkqyYXcBQZ5hZ9BFHBiVnmrZ1C1HCpesgZQoTdgjLdU6Ah",
"studyProgram": "Master Studies in Computer Science",
"learningAchievement": "Master of Science",
"dateOfAchievement": "2021-03-18T00:00:00.000Z",
"eqfLevel": "http://data.europa.eu/snb/eqf/7",
"targetFrameworkName": "European Qualifications Framework for lifelong learning - (2008/C 111/01)"
},
"issuanceDate": "2023-07-29T20:18:05Z",
"proof": {
"type": "Ed25519Signature2020",
"created": "2023-07-29T20:18:05Z",
"proofPurpose": "assertionMethod",
"verificationMethod": "did:key:z6MkrBLbiyN7pDuoK6esPDQas7FYeueVVAKz8ZtMaMcFpDE2#z6MkrBLbiyN7pDuoK6esPDQas7FYeueVVAKz8ZtMaMcFpDE2",
"proofValue": "z4Ka1ScNSgG6ZaBR1i6KyV31DyeBTueZY3KXPTtfsijnSBXZt4D9YgbJcqW1HjmprBpPLeFabbAJ5s4BAzsP1c2WU"
}
},
"options": {
"returnMetadata": true,
"credentialFormatOptions": {
"documentLoaderEnableHttps": true
}
}
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41