PUT /api/businesses/{BusinessID}/challenges

Adds information about the security challenge questions for a business.

Note: When you change a setting, it might take up to five minutes for the change to take effect.

Authorization Roles/Permissions: Site Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/businesses/{BusinessID}/challenges

Sample Request

The example below shows update of the business security challenge questions for the specified business. Constraints are set for the answers to one of the challenge questions.

Sample Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/challenges

Sample request headers

Accept: application/vnd.soa.v72+json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body: application/json

In the example below, the first four questions were already existing. The last one is new, so the request content includes additional information the user has specified about the new question, such as minimum and maximum number of characters allowed. It's only necessary to include the settings if the values are not the default values.

{
  "Challenge":[
    {
      "IsCaseSensitive":false,
      "CanContainSpaces":true,
      "Active":true,
      "ChallengeCode":"com.soa.challenge.question.city.birth",
      "ChallengeQuestion":"What is the city of your birth?"
    },
    {
      "IsCaseSensitive":false,
      "CanContainSpaces":true,
      "Active":true,
      "ChallengeCode":"com.soa.challenge.question.color",
      "ChallengeQuestion":"What is your favorite color?"
    },
    {
      "IsCaseSensitive":false,
      "CanContainSpaces":true,
      "Active":true,
      "ChallengeCode":"com.soa.challenge.question.mothers.name",
      "ChallengeQuestion":"What is your mother's maiden name?"
    },
    {
      "IsCaseSensitive":false,
      "CanContainSpaces":true,
      "Active":true,
      "ChallengeCode":"com.soa.challenge.question.pet",
      "ChallengeQuestion":"What is the name of your pet?"
    },
    {
      "IsCaseSensitive":false,
      "CanContainSpaces":false,
      "Active":true,
      "AllowedSpecialCharacters":{
        "AllowedSpecialCharacter":[
        ]
      },
      "ChallengeCode":"17",
      "ChallengeQuestion":"What is the last letter of your father's name?",
      "MinimumLength":"1",
      "MaximumLength":"1",
      "MinimumAlphaCount":"1",
      "MaximumAlphaCount":"1",
      "MinimumNumberCount":"0"
    }
  ]
}

Request Headers

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

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.
Challenges	Body	Challenges	Required	Contains information about one or more business challenges (security questions and answers). You must send the entire set of challenge questions, not just one or more new ones.

Response

If successful, this operation returns HTTP status code 200, with information about the updated security questions.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Tue, 23 Jan 2018 20:49:53 GMT

Sample response body: application/vnd.soa.v81+json

{
  "Challenge":[
    {
      "ChallengeCode":"com.soa.challenge.question.city.birth",
      "ChallengeQuestion":"What is the city of your birth?",
      "CanContainSpaces":true,
      "IsCaseSensitive":false,
      "Active":true
    },
    {
      "ChallengeCode":"com.soa.challenge.question.color",
      "ChallengeQuestion":"What is your favorite color?",
      "CanContainSpaces":true,
      "IsCaseSensitive":false,
      "Active":true
    },
    {
      "ChallengeCode":"com.soa.challenge.question.mothers.name",
      "ChallengeQuestion":"What is your mother's maiden name?",
      "CanContainSpaces":true,
      "IsCaseSensitive":false,
      "Active":true
    },
    {
      "ChallengeCode":"com.soa.challenge.question.pet",
      "ChallengeQuestion":"What is the name of your pet?",
      "CanContainSpaces":true,
      "IsCaseSensitive":false,
      "Active":true
    },
    {
      "ChallengeCode":"17",
      "ChallengeQuestion":"What is the last letter of your father's name?",
      "MinimumLength":1,
      "MaximumLength":1,
      "MinimumAlphaCount":1,
      "MaximumAlphaCount":1,
      "MinimumNumberCount":0,
      "CanContainSpaces":false,
      "IsCaseSensitive":false,
      "Active":true,
      "AllowedSpecialCharacters":{
        "AllowedSpecialCharacter":[
        ]
      }
    }
  ]
}

Response Headers

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

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

Response Body

Name	Type	Description
Challenges	Challenges	Contains information about one or more business challenges (security questions and answers).

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
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.For example, you might get this response if you send malformed JSON or XML in your request.
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