POST/setBrokerCode

Set Document IDs / Broker Codes before submitting application

Broker APIPersonal LoanAuto Loan

🔑 Authentication

• Bearer Token - Your API token

📝 Content-Type

Request	application/json
Response	application/json

📦 Request Body

hash Required

string

Customer's hash

brokerflow_document_ids Required

Array<string>

Illion broker code.
Each id must be alphanumeric and no more than 9 characters

ℹ️ Examples

Request

{
  "hash": "QDmSIB6nAbtg7aMvwfnyFZjx8rZ8Eg8EyByHI8iqY4wERm029xK6UQTutVOx",
  "brokerflow_document_ids": [
    "A1B2C3",
    "D4E5F6"
  ]
}

Response

✅ 200

{
  "message": "success"
}

❌ 400 (App Submitted)

{
  "message": "Unable to process application that has been submitted, please check the application.",
  "error_code": "app submitted"
}

❌ 401 (Unauthenticated)

{
  "message": "Unauthenticated."
}

❌ 422 (Required Validation)

{
  "message": "The brokerflow document ids field is required.",
  "errors": {
    "brokerflow_document_ids": [
      "The brokerflow document ids field is required."
    ]
  }
}

❌ 422 (Array Validation)

{
  "message": "The brokerflow document ids must be an array.",
  "errors": {
    "brokerflow_document_ids": [
      "The brokerflow document ids must be an array."
    ]
  }
}

❌ 422 (Array of Strings Validation)

{
  "message": "The brokerflow_document_ids.0 must be a string.",
  "errors": {
    "brokerflow_document_ids.0": [
      "The brokerflow_document_ids.0 must be a string."
    ]
  }
}

❌ 422 (Alphanumeric Validation)

{
  "message": "The brokerflow_document_ids.0 may only contain letters and numbers.",
  "errors": {
    "brokerflow_document_ids.0": [
      "The brokerflow_document_ids.0 may only contain letters and numbers."
    ]
  }
}

❌ 422 (Greater than 9 characters Validation)

{
  "message": "The brokerflow_document_ids.0 may not be greater than 9 characters.",
  "errors": {
    "brokerflow_document_ids.0": [
      "The brokerflow_document_ids.0 may not be greater than 9 characters."
    ]
  }
}