Validate the Propay account provisioning entity against the required merchant data and configuration.

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

Usage Info

Validate that a Propay account provisioning entity has all the required information to execute provisioning operations, including complete business data, owner information, bank accounts, sales information, documents, and partner configuration settings.

Use this method before calling propay.execute to identify any missing requirements and ensure successful provisioning. The validation checks vary depending on the operation type (onboarding vs. document sync) to be executed.

For troubleshooting validation errors and finding the right API endpoints, see Propay Validation Reference.

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_7h1EpxerrZQyLnRC1EQ9Ck"
}

Response

Data

Parameter	Type	Description
can_execute	boolean	Specifies whether the Propay provisioning can be executed or not.
missing_requirements	array of objects	The missing requirements attribute is defined in the table below.

Missing Requirements Parameters

Parameter	Type	Description
code	string	Type of the missing requirement.
entity_type	string	Entity type related to the missing requirement. See Propay Validation Reference for the list of entity types and their required fields.
entity_id	string	Identifier for the entity with the missing requirement.
message	string	A descriptive message explaining the missing requirement.
related_methods	array	API methods that can be used to fulfill this requirement.
fields	array	When the missing requirement is of type `FIELDS_REQUIRED`, the list of fields missing from the specified entity.

Example without missing requirements

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "can_execute": true,
		"missing_requirements": []
  }
}

Example with missing requirements

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "can_execute": false,
    "missing_requirements": [
      {
        "code": "BUSINESS_OWNER_REQUIRED",
        "entity_type": "BusinessOwner",
        "entity_id": "b_7h1EpxerrZQyLnRC1EQ9Ck",
        "message": "At least one business owner with complete information is required",
        "related_methods": [
          "person.create",
          "business.addOwner"
        ]
      },
      {
        "code": "FIELDS_REQUIRED",
        "entity_type": "Business",
        "entity_id": "b_7h1EpxerrZQyLnRC1EQ9Ck",
        "message": "Required fields are missing from the business entity",
        "related_methods": [
          "business.create",
          "business.update"
        ],
        "fields": [
          "legal_name",
          "tax_number",
          "mcc"
        ]
      },
      {
        "code": "SALES_DETAILS_REQUIRED",
        "entity_type": "BusinessSalesInfo",
        "entity_id": "b_7h1EpxerrZQyLnRC1EQ9Ck",
        "message": "Sales information is required for ProPay provisioning",
        "related_methods": [
          "business.salesInfo.create",
          "business.salesInfo.update"
        ]
      }
    ]
  }
}

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.