Get Onboarding Details

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 methodEndpointPath Variable
GET/api/v1/onboardings/:idid | uuid of the onboarding

Headers #

Authentication
Please see Using a Token for a detailed description of how to authenticate yourself with our API.
NameValue
Content-Typeapplication/json

Response #

Body #

KeyDescriptionType
idUnique uuid of the onboardingstring
createdAtDate at which the ressource has been createdstring
updatedAtDate at which the ressource has been last modifiedstring
identifierIdentifier object containing the DID used for the onboardingjson
identifierIdUnique id of the identifier objectstring
credentialTypeType of requested credentialenum(string) | IdentityCredential OR DSCSAATPCredential
returnUrlURL which to return the user tostring
userIdUnique id of the user who initiated the onboardingstring
eventsArray of event objects which are sorted descending by creation date - Each event represents one state change in the onboardingjson

Identifier Object #

KeyDescriptionType
didDID used for the onboardingstring

Event Object #

KeyDescriptionType
idInternal id of the eventstring
createdAtDate at which the ressource has been createdstring
statusStatus name of the eventstring

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"
    }
  ]
}