Retrieve comprehensive information about an MBTrust account provisioning entity and its execution history.

POST http://api.kompliant.com/mbtrust.get (OpenAPI specification)

Usage Info

This method returns detailed information about an MBTrust account provisioning entity, including its associated workflow, subject record, timestamps, and the complete execution history of all provisioning operations. Use this method to monitor operation progress, track status changes, and verify successful completion of onboarding or document sync operations.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Field	Type	Required	Description
`mbtrust_id`	string	Yes	The identifier for the MBTrust provisioning entity.

Example

{
  "mbtrust_id": "ape_4kz3kXp8dL2Xnj97xzFMuG"
}

Response

Data

Parameter	Type	Description
mbtrust	object	The mbtrust parameter is defined in the tables below.

MbTrust Parameters

Field	Type	Description
`mbtrust_id`	string	Unique identifier for the provisioning entity (format: `ape_XXXXX...`)
provisioning_type	string	The type of provisioning. Must be one of the ACCOUNT_PROVISIONING_TYPES.
provisioning_sponsor	string	The sponsor for provisioning. Must be one of the ACCOUNT_PROVISIONING_SPONSORS.
status	string	The current status of the provisioning entity. Must be one of the ACCOUNT_PROVISIONING_ENTITY_STATUSES.
`workflow_id`	string	The Account Provisioning workflow ID (format: `w_XXXXX...`)
`subject_record_id`	string	The Subject Record ID associated with this provisioning (format: `sr_XXXXX...`)
`created_at`	string	ISO 8601 timestamp when the entity was created
`updated_at`	string	ISO 8601 timestamp when the entity was last updated
`execution_results`	array	Array of operation execution records (see below)

Execution Results Parameters

Each item in the execution_results array represents a single provisioning operation:

Field	Type	Description
`operation_id`	string	Unique identifier for this operation execution (format: `ap_XXXXX...`)
`operation_type`	string	Type of the operation processed. One of ACCOUNT_PROVISIONING_OPERATIONS .
`status`	string	Current status of the account provisioning operation. One of ACCOUNT_PROVISIONING_OPERATION_STATUSES .
`started_at`	string	ISO 8601 timestamp when the operation started
`finished_at`	string	ISO 8601 timestamp when the operation completed. Only present when status is terminal.
`errors`	array	Array of error objects. Empty for successful operations.
`provider_response`	object	Raw response data from the MBTrust provider (varies by operation type)
`documents`	array	(DOCUMENT_SYNC only) List of document IDs that were successfully uploaded. Only present when there were partial failures.
`external_reference_id`	string	(Conditional) The Merchant ID assigned by MBTrust. Only present when `provider_response` is empty.

Error parameters

When operations fail, the errors array contains error objects:

Field	Type	Description
`code`	string	Error code identifying the type of error
`message`	string	Human-readable error description
`details`	string	error details

Details parameters

Example

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24"
  },
  "data": {
    "mbtrust": {
      "mbtrust_id": "ape_4kz3kXp8dL2Xnj97xzFMuG",
      "provisioning_type": "MBTRUST",
      "provisioning_sponsor": "MERRICK",
      "status": "COMPLETED",
      "workflow_id": "w_7kR9mNp2dQ5Zxj73zAFMtH",
      "subject_record_id": "sr_163Gh1ONk6BCHF9iYVDHcv",
      "created_at": "2026-01-18T07:29:18.472Z",
      "updated_at": "2026-01-18T07:32:45.891Z",
      "execution_results": [
        {
          "operation_id": "ap_5kL8xPq2mN3rY9zW1vH4Tb",
          "operation_type": "ONBOARDING",
          "status": "SUCCESS",
          "started_at": "2026-01-18T07:30:22.156Z",
          "finished_at": "2026-01-18T07:32:45.891Z",
          "errors": [],
          "provider_response": {
            "merchant_id": "123456789012345",
            "status": "active"
          }
        },
        {
          "operation_id": "ap_7nM9aRs4pQ6tZ2xV3wJ5Ud",
          "operation_type": "DOCUMENT_SYNC",
          "status": "SUCCESS",
          "started_at": "2026-01-18T07:32:50.234Z",
          "finished_at": "2026-01-18T07:33:15.567Z",
          "errors": [],
          "provider_response": {}
        }
      ]
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `mbtrust_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below.

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Account	ACCOUNT_PROVISIONING_DISABLED	The account provisioning feature is disabled for this account.
Account	PROVISIONER_DISABLED	The MBTrust provisioner is disabled for this account.