POST /api/users/verifyInvitation

Validates an invitation code at the signup page and returns user details.

Authorization Roles/Permissions: None needed. However a valid invitation code is needed to successfully complete the operation.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/users/verifyInvitation

Sample Request

The example below shows a request to complete the signup in the Simple Developer UI.

Sample Request URL

https://{hostname}/api/users/verifyInvitation

Sample request headers

POST /api/users/verifyInvitation HTTP/1.1
Host: <SimpleDevHostname>
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Sample request body

validationCode=3rHzXi2goEyAGDQeTp0UYsayC5qzbzvv1F4ottYTLaDdffpA22UqEu8eQzr3I9V_JKfbM-R8H1gzjC8KaynxymqfQH41kU0JmixaLM2NTGSrM0Y9co2bX9wOObQ

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type	application/x-www-form-urlencoded

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
validationCode	signupCode	string	Required	A unique code generated for the user to complete the signup process.

Response

If successful, this operation returns HTTP status code 200, with information about the user who is signing up.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Wed, 27 Jan 2016 20:03:44 GMT
Content-Type: application/json

Sample response body: application/json

{
  "userName" : "506994e4-d840-47c7-84f5-ad3bbae13d36",
  "firstName" : "",
  "lastName" : "",
  "domainName" : "Local Domain",
  "userID" : "506994e4-d840-47c7-84f5-ad3bbae13d36.acmepaymentscorp",
  "authIdentifier" : "",
  "profileName" : "jane.mead@acmepaymentscorp.com",
  "loginDomainID" : "siteusers.acmepaymentscorp",
  "userPhones" : {
    "UserPhone" : [ ]
  },
  "emailAddress" : "jane.mead@acmepaymentscorp.com",
  "expired" : false,
  "signupStatus" : "user.signup.confirm.email",
  "state" : "invited"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
SignupResponse	SignupResponse	Contains basic signup information about the user, including the unique user ID assigned by the platform.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics