Get Onboarding Details #

The get onboarding details endpoint may be used to retrieve details for a specific onboarding uuid. This uuid may be shared with you beforehand to be used in this call.

Request #

Method #

Request method	Endpoint	Path Variable
`GET`	`/api/v1/onboardings/:id`	id \| uuid of the onboarding

Headers #

Authentication
Please see Using a Token for a detailed description of how to authenticate yourself with our API.

Name	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer [token]`

Response #

Body #

Key	Description	Type
`id`	Unique uuid of the onboarding	string
`createdAt`	Date at which the ressource has been created	string
`updatedAt`	Date at which the ressource has been last modified	string
`identifier`	Identifier object containing the DID used for the onboarding	json
`identifierId`	Unique id of the identifier object	string
`credentialType`	Type of requested credential	enum(string) \| IdentityCredential OR DSCSAATPCredential
`returnUrl`	URL which to return the user to	string
`userId`	Unique id of the user who initiated the onboarding	string
`events`	Array of event objects which are sorted descending by creation date - Each event represents one state change in the onboarding	json

Identifier Object #

Key	Description	Type
`did`	DID used for the onboarding	string

Event Object #

Key	Description	Type
`id`	Internal id of the event	string
`createdAt`	Date at which the ressource has been created	string
`status`	Status name of the event	string

Examples #

Example response body

{
  "id":"90358ff6-8822-4588-8e51-88cb3cbc4399",
  "createdAt":"2022-02-28T16:35:14.668Z",
  "updatedAt":"2022-02-28T16:35:14.668Z",
  "identifier":{
    "did":"did:key:z6Mkvuuw4EhjssdXj3SShaSWNoEyJ1escEtj1tTnArcWCcDf"
  },
  "identifierId":"bcc557d6-349f-4f9c-af91-b28168e496e8",
  "credentialType":"IdentityCredential",
  "returnUrl":"https://example.com/",
  "userId":"12412451241421",
  "events":[
    {
      "id":"a9f6f502-b590-4972-a32a-7898b2a9870f",
      "createdAt":"2022-02-29T12:35:14.668Z",
      "status":"initiated"
    }
  ]
}