Answer a challenge

POST

/app/{appId}/sessions/{sessionId}/challenges/{challengeId}

Submits an end-user’s answer to a challenge

Parameters

Path Parameters

challengeId

required

Unique identifier for the challenge

string

sessionId

required

string

Unique identifier for the session

Request Body ^required

Request body for submitting a response to a challenge

Media type application/json

One of:

Price

object

cType

string

Allowed values: price

value

string

/^\d+\.\d{2}$/

Datetime

object

cType

string

Allowed values: datetime

value

string format: date-time

File

object

cType

string

Allowed values: doc screenshot photo

value

string format: binary

Text

object

cType

string

Allowed values: text url location

value

string

Account

object

cType

string

Allowed values: account

value

One of:

UK_ACCOUNT

object

type

Type of bank account identifier.

string

Allowed values: GB_BSC_AN

sort_code

Sort code (for UK bank accounts).

string

account_number

Account number (for UK bank accounts).

string

IBAN

object

type

Type of bank account identifier.

string

Allowed values: IBAN

iban

International Bank Account Number (see ISO 13616:2020).

string

/^[A-Z]{2}\d{2}[A-Z]\d]{,30}$/

bic

Bank Identifier Code.

string

/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/

Contact

object

cType

string

Allowed values: contact

value

object

name

string

email

string format: email

phone

string

Number

object

cType

string

Allowed values: number

value

One of:

number

number

integer

integer

Responses

200

Media type application/json

One of:

ChallengeSession

Next challenge to complete

object

id

UUID of the newly created session

string format: uuid

locator

Uniquely identifies a challenge presented to a user within a session.

The investigationId and field describe what data was requested from the user in the challenge.

object

challengeId

string format: uuid

investigationId

string format: uuid

field

string

ReportSession

UserReport screen to acknowledge

object

id

UUID of the newly created session

string format: uuid

report

object

riskSignals

required

Array<object>

nullable

object

type

required

string

Allowed values: TRUST INFO RISK

flag

required

string

Allowed values: MISMATCH NOT_FOUND UNREALISTIC_PRICE COMPANY_FCA_AUTHORISED COMPANY_FCA_UNAUTHORISED DOMAIN_NICE TONE_OF_VOICE_PUSHY TONE_OF_VOICE_URGENT TONE_OF_VOICE_THREATENING

Example

{
  "report": {
    "riskSignals": [
      {
        "type": "TRUST",
        "flag": "MISMATCH"
      }
    ]
  }
}