api_auth

<back to all web services

JoinRequest

The following routes are available for this service:
GET/api/joinInformation about invitation corresponding to the given pass phrase. Based on this information user can decide whether or not to accept this invitation
POST/api/joinAccept invitation corresponding to the given pass phrase.
JoinRequest Parameters:
NameParameterData TypeRequiredDescription
PassPhrasebodystringNoPass phrase received by user during invitation process
SiteIDbodylong?NoID of a site to join to (if joining without invitation)
PseudonymIDbodyint?NoPseudonym for this site (optional)
InvitationDetailResponse Parameters:
NameParameterData TypeRequiredDescription
ValidformboolNo
UsedformboolNo
ExistsformboolNo
ExpiredformboolNo
ExpirationTimeformDateTime?No
SiteformstringNo
GroupformstringNo
IssuerformstringNo
IsStrictEmailformboolNo
EmailformstringNo
TelephoneformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/join HTTP/1.1 
Host: 1.hyper.id 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"passPhrase":"String","siteID":0,"pseudonymID":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"valid":false,"used":false,"exists":false,"expired":false,"expirationTime":"0001-01-01T00:00:00.000Z","site":"String","group":"String","issuer":"String","isStrictEmail":false,"email":"String","telephone":"String"}