POST/simulate/ask-created

Simulate Ask Created

Simulates an agent question (ask) being created on an application. Moves the form to missing (status 2) and fires the form.incomplete webhook. The ask then appears in Asks[] from GET /application/detail/{id} and can be answered via POST /application/ask/answer.

Blocked in production. Returns 400 when simulation is disabled.

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired

SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

FieldTypeRequiredPossible valuesDescription
IdstringRequired

Application ID.

QuestionstringRequired

The question text to create as an ask. This exact string must be passed to `POST /application/ask/answer` when answering.

Example request

{
  "Id": "6a4763a25f39cb7aee21f0e3",
  "Question": "Please confirm the registered business address."
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503

API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).

ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity

Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.

ResponseDataobjectPlease refer to below example for response body

The updated business object after the ask was created.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Version": 4,
    "ApplicationId": "6a4763a25f39cb7aee21f0e3",
    "Type": 1,
    "CreatedAt": 1783063458,
    "UpdatedAt": 1783074012,
    "EntityType": "Limited_Liability_Company",
    "AmountOfInitialDeposit": 10000,
    "AverageBalance": 50000,
    "NumberOfMonthlyAchDeposits": 5,
    "AmountOfMonthlyAchDeposits": 10000,
    "NumberOfMonthlyDomesticWireDeposits": 5,
    "AmountOfMonthlyDomesticWireDeposits": 20000,
    "NumberOfMonthlyInternationalWireDeposits": 2,
    "AmountOfMonthlyInternationalWireDeposits": 15000,
    "NumberOfMonthlyAchPayments": 5,
    "AmountOfMonthlyAchPayments": 10000,
    "NumberOfMonthlyDomesticWirePayments": 5,
    "AmountOfMonthlyDomesticWirePayments": 20000,
    "NumberOfMonthlyInternationalWirePayments": 2,
    "AmountOfMonthlyInternationalWirePayments": 15000,
    "ExpectedAmountMonthlyDigitalCurrencyCustody": 0,
    "CountOfMonthlyCryptocurrencyConversions": 0,
    "AmountOfMonthlyCryptocurrencyConversions": 0,
    "NumberOfMonthlyStablecoinConversionsDeposits": 0,
    "AmountOfMonthlyStablecoinConversionsDeposits": 0,
    "NumberOfMonthlyStablecoinConversionsPayments": 0,
    "AmountOfMonthlyStablecoinConversionsPayments": 0,
    "HasBusinessPlan": true,
    "Businesses": [
      "Other"
    ],
    "BusinessOther": "Software services",
    "SignerFirstName": "John",
    "SignerLastName": "Smith",
    "Tnc": true,
    "AcceptDelarationAggrement": true,
    "Signature": "John Smith",
    "RegulatedDisclosure": false,
    "RegulatoryAgency": [],
    "MoneyServicesBusiness": false,
    "MerchantAcquirerPsp": false,
    "Phone": "5550000000",
    "PrimaryBusinessActivities": "Software development",
    "BusinessProductServices": "SaaS platform",
    "CustomerDescription": "Small businesses",
    "BusSourceOfFunds": [
      "revenue_from_business_operations"
    ],
    "IllegalImmoralDisclosure": [
      "none_of_the_above"
    ],
    "DepositReasons": [
      "receiving_funds_against_invoices_from_customer"
    ],
    "PaymentReasons": [
      "technology_and_it"
    ],
    "DepositLocations": [
      "usa"
    ],
    "PaymentLocations": [
      "usa"
    ],
    "HasEntity": false,
    "Entities": [],
    "Penalty": false,
    "Litigation": false,
    "LiquidFunds": false,
    "BankAccountAnotherFinancialInstitution": false,
    "MobilePhone": "5551112222",
    "LandlinePhone": "1134960000",
    "Website": true,
    "Url": "https://example.com",
    "Engage": "Online and direct sales",
    "EmpCount": "1_10",
    "BusinessName": "Example Broker Managed LLC",
    "DoingBusinessAs": "Example BM",
    "AddressList": [
      {
        "City": "New York",
        "State": "NY",
        "Country": "US",
        "PinCode": "10001",
        "Street": "5th Avenue",
        "BuildingNumber": "100",
        "Type": "REGISTERED"
      },
      {
        "City": "New York",
        "State": "NY",
        "Country": "US",
        "PinCode": "10001",
        "Street": "5th Avenue",
        "BuildingNumber": "100",
        "Type": "MAILING"
      }
    ],
    "Address": {
      "City": "New York",
      "State": "NY",
      "Country": "US",
      "PinCode": "10001",
      "Street": "5th Avenue",
      "BuildingNumber": "100"
    },
    "BusinessRegistrationCountry": "US",
    "BusinessTaxId": "12-3456789",
    "Ein": "12-3456789",
    "BusinessRegistrationNumber": "REG-1234565",
    "BusinessFormationDate": "20200101",
    "InOperation": true,
    "OperationStartDate": "20200101",
    "BusinessIndustryType": "information",
    "InternationalCustomers": [
      "None_of_the_above"
    ],
    "HasCoinConversionPlan": false,
    "HasCryptoConversionPlan": false,
    "DealsInCryptocurrency": false
  }
}

Fires the `form.incomplete` webhook event.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose