Result

Every WorldFirst enhanced API response includes a
result
object that indicates the outcome of the request. The HTTP status code is always
200 OK
regardless of the business outcome — use the
result
object to determine whether the request succeeded, failed, or requires retry.

Fields

ResultStatus

Examples

Success

{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success"
  }
}

Failure

{
  "result": {
    "resultStatus": "F",
    "resultCode": "PARAM_ILLEGAL",
    "resultMessage": "One or more request parameters are invalid."
  }
}

Unknown

{
  "result": {
    "resultStatus": "U",
    "resultCode": "UNKNOWN_EXCEPTION",
    "resultMessage": "An unexpected server error occurred. The outcome of the request is indeterminate."
  }
}

Field Relationships

Key Rules

  • resultStatus
    ** is authoritative.** Always check it first; never rely on HTTP status codes alone.
  • **When **
    resultStatus = S
    ,
    resultCode
    must be
    SUCCESS
    . No other success codes are defined.
  • **When
    resultStatus = F
    or **
    U
    ,
    resultCode
    contains a specific error code for programmatic handling.
  • Build logic on
    resultCode
    , not
    resultMessage
    .
    resultMessage
    is for human readers and may change across locales or API versions.
  • Each endpoint's Error Codes section lists only business-specific codes. For general-purpose error codes that apply across all endpoints, see the General Error Codes table below.

General Error Codes

The following error codes apply to all API endpoints. Each endpoint's Error Codes section lists only additional business-specific codes — these general codes are always possible responses from any endpoint.