The examples below do not necessarily equate to any given API from Kompliant Web API. They are meant to showcase the format of responses.

Regular APIs

Successful Result

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "workflow_id": "w_2dJFFW3HY8a3zOjqwUXhQc",
    "subject_record_id": "sr_4vrv6U1vdpc341MO7cF8pE"
  }
}

Successful Result with no data

This might be the case when the API does not return any data, such as a delete API.

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_58UrqIhB29EmDQryqQ7Xg7",
    "version": "2025-03-24"
  },
  "data": {}
}

Error Result

{
  "meta": {
    "status": "ERROR",
    "trace_id": "trc_7ADjjtrOAEXmZZa7BsMQsb",
    "version": "2025-03-24"
  },
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "The API Key 'sb_3eY9UJuj09636NVPlgmhfa' is not authorized for this request."
    }
  ]
}

Batch APIs

All Successful Results

{
  "meta": {
    "status": "BATCH_PROCESSED",
    "trace_id": "trc_49bUKH7g6JPkwqWyF1iJqx",
    "version": "2025-03-24"
  },
  "results": [
    {
      "status": "SUCCESS",
      "request": {
		    "bank_routing_number": "021000021",
    	  "bank_account_number": "XXXXXXX123",
      },
      "data": {
        "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS"
      }
    },
    {
      "status": "SUCCESS",
      "request": {
        "bank_routing_number": "123006800",
        "bank_account_number": "XXXXXXX789",
      },
      "data": {
        "bank_account_id": "ba_6ITSh3KdGAOupyRX7K2Qpv"
      }
    }
  ]
}

Partially Successful Results

{
  "meta": {
    "status": "BATCH_PROCESSED",
    "trace_id": "trc_17oObSlQYdDzNUBX58PeSY",
    "version": "2025-03-24"
  },
  "results": [
    {
      "status": "SUCCESS",
      "request": {
        "bank_routing_number": "021000021",
    	  "bank_account_number": "XXXXXXX123",
      },
      "data": {
        "bank_account_id": "ba_6zNzQZHSf26V83BO3uW6dS"
      }
    },
    {
      "status": "ERROR",
      "request": {
        "bank_routing_number": "123006800",
        "bank_account_number": "XXXXXXX789"
      },
      "errors": [
        {
          "code": "ENTITY_NOT_FOUND",
          "message": "The given entity(s) does not exist.",
          "details": [
            { "subject_record_id": "sr_3QkVlYGvQaVqD5FMdl0oDx" }
          ]
        }
      ]
    }
  ]
}

All Requests Failed

{
  "meta": {
    "status": "BATCH_PROCESSED",
    "trace_id": "trc_6uxmDIYxzQEmqjzZ6ur5YF",
    "version": "2025-03-24"
  },
  "results": [
    {
      "status": "ERROR",
      "request": {
        "bank_routing_number": "021000021",
    	  "bank_account_number": "XXXXXXX123",
      },
      "errors": [
        {
          "code": "ENTITY_NOT_FOUND",
          "message": "The given entity(s) does not exist.",
          "details": [
            { "subject_record_id": "sr_3QkVlYGvQaVqD5FMdl0oDx" }
          ]
        }
      ]
    },
    {
      "status": "ERROR",
      "request": {
        "bank_routing_number": "123006800",
        "bank_account_number": "XXXXXXX789"
      },
      "errors": [
        {
          "code": "ENTITY_NOT_FOUND",
          "message": "The given entity(s) does not exist.",
          "details": [
            { "subject_record_id": "sr_3QkVlYGvQaVqD5FMdl0oDx" }
          ]
        }
      ]
    }
  ]
}

Error Result

{
  "meta": {
    "status": "ERROR",
    "trace_id": "trc_3QkVlYGvQaVqD5FMdl0oDx",
    "version": "2025-03-24"
  },
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "The API Key 'sb_3eY9UJuj09636NVPlgmhfa' is not authorized for this request."
    }
  ]
}