Retrieve comprehensive information about a Propay account provisioning entity and its execution history.

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

Usage Info

This method returns detailed information about a Propay 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

Parameter	Type	Required	Description
propay_id	string	Yes	The identifier for the Propay provisioning entity.

Example

{
  "propay_id": "ape_2dJFFW3HY8a3zOjqwUXhQc"
}

Response

Data

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

Propay Parameters

Parameter	Type	Description
propay_id	string	The identifier for the Propay provisioning entity.
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 ID for the Workflow associated with this provisioning entity.
subject_record_id	string	The ID for the Subject Record associated with the Workflow.
execution_results	array	Account provisioning operations that have been executed. The execution result parameter is defined below.
created_at	string	The date-time when the Propay entity was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Propay entity was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Execution Results Parameters

Parameter	Type	Description
operation_id	string	Unique identifier for this specific operation execution.
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. Note: `COMPLETED` is returned as `SUCCESS`.
started_at	string	The date-time when the operation was started. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
finished_at	string	The date-time when the operation was finished. This field is only present when the status is `SUCCESS` or `FAILED`. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
errors	array	Array of error objects. Only present when status is `FAILED`. Each error contains structured information about what went wrong during the operation.
provider_response	object	The response received from the ProPay provider during the most recent API call for this operation.
decrypted_data	object	Sensitive provisioning data including account credentials. Only included when explicitly requested with appropriate authorization.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "propay": {
      "propay_id": "ape_2dJFFW3HY8a3zOjqwUXhQc",
      "provisioning_type": "ACCOUNT_PROVISIONING",
      "provisioning_sponsor": "GLOBAL_PAYMENTS",
      "status": "CREATED",
      "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
      "subject_record_id": "sr_163Gh1ONk6BCHF9iYVDHcv",
      "created_at": "2025-01-18T07:29:18.472Z",
      "updated_at": "2025-01-18T07:32:45.891Z",
      "execution_results": [
        {
          "operation_id": "ap_5kL8xPq2mN3rY9zW1vH4Tb",
          "operation_type": "ONBOARDING",
          "status": "SUCCESS",
          "started_at": "2025-01-18T07:30:22.156Z",
          "finished_at": "2025-01-18T07:32:45.891Z",
          "errors": [],
          "provider_response": {
            "account_number": "PP987654321",
            "status": "00"
          }
        }
      ]
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `propay_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 ProPay provisioner is disabled for this account.