POST /api/users/verifySignup

Returns information about the signup code or where in the signup process the user is.

There are two main scenarios for this operation:

  • The operation sends a signup code from a signup email. The user is signing in via a signup code sent in a notification email as a result of self-registration.
  • The operation sends no signup code (signupCode=). In this case, the currently authenticated third-party user (for example, a Google or Facebook user) is authenticated by the third-party authentication provider, and then the user's registration details, as recorded in the specified Google or Facebook account, are returned in a cookie. If there is no signup code, the operation looks for the cookie showing that the user was authenticated by a third-party provider.

Note: If the specified signupCode has expired, this API triggers a new email to the user (as if the signupUser API was called).

Authorization Roles/Permissions: None required.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

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

Back to top

Sample Request

The sample request URL below shows this operation in action when the user is signing up in the platform, without using third-party credentials. A legal agreement is in place, so the user must accept the legal agreement in order to activate the user account.

Request URL

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

Request headers

POST /api/users/verifySignup HTTP/1.1 
Host: {hostname} 
Accept: application/json, text/javascript, */*; q=0.01 
Content-Type: application/x-www-form-urlencoded

Sample request body (line break added)

signupCode=M6Qpusx8m84ioG-rOeg-yeJGFSzortljvks0lghPpIC7qp4hn7ehs5Cp8tiKMHb7cgdzYWpplaugFndYtB6sLnnvHOdeHDV
yQVQqzYw5Sf1cFGyyPzo5APCNCKk

Back to top

Request Headers

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

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
signupCode Form string Required The signup code sent to the user in the verification email.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the user's signup information in the form of a JSON object.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK 
Date: Thu, 07 Jan 2016 19:24:16 GMT 
Content-Type: application/json

Sample response body: local user initiating signup

{
  "userName" : "JaneMead",
  "userID" : "ff239e31-c387-419d-9d67-40a76cf5f92b.acmepaymentscorp",
  "firstName" : "Jane",
  "lastName" : "Mead",
  "authIdentifier" : "",
  "profileName" : "JaneMead",
  "loginDomainID" : "siteusers.acmepaymentscorp",
  "userPhones" : {
    "UserPhone" : [ {
      "CountryCode" : "+1",
      "PhoneNumber" : "1231231234",
      "Verified" : false,
      "Primary" : false
    } ]
  },
  "emailAddress" : "jane.mead@acmepaymentscorp.com",
  "expired" : false,
  "domainName" : "Local Domain",
  "state" : "pending_validation"
}

Back to top

Response Headers

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

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

Back to top

Response Body

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

Back to top

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
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics