Guides

Get Organization KYC status

After creating an Organization, you can check the status of the its KYC approval by calling the GET endpoint.

Example request

curl --request GET \
     --url https://api.muralpay.com/api/organizations/807742f0-e76c-44cd-bbe9-30b02e0060f4 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer $API-KEY'

Example response

{
    "type": "business",
    "name": "Sun Tree Capital Llc",
    "id": "807742f0-e76c-44cd-bbe9-30b02e0060f4",
    "createdAt": "2025-04-04T16:32:17.074Z",
    "updatedAt": "2025-04-04T16:36:00.592Z",
    "kycStatus": {
      "type": "approved"
    },
    "tosStatus": ACCEPTED
    "currencyCapabilities": [
        {
            "fiatAndRailCode": "usd",
            "currencyCode": "USD",
            "depositStatus": {
                "type": "enabled"
            },
            "payOutStatus": {
                "type": "enabled"
            }
        },
        ...
    ]
}
{
    "type": "business",
    "name": "Sun Tree Capital LLC",
    "id": "807742f0-e76c-44cd-bbe9-30b02e0060f4",
    "createdAt": "2025-04-04T16:32:17.074Z",
    "updatedAt": "2025-04-04T16:32:17.074Z",
    "kycStatus": {
      "type": "rejected",
      "reason": "Unable to verify provided identification document"
    },
	  "tosStatus": ACCEPTED,
    "currencyInfos": []
}

Organization KYC Statuses

  • INACTIVE: The KYC process has not been started.
  • PENDING: The KYC process is in progress.
  • APPROVED: The KYC process is complete and approved.
  • ERROR: There was an error on the KYC process. Please contact support at [email protected].
  • REJECTED: The organization KYC process was rejected.

on-behalf-of Header

After an Organization's KYC is approved, you can perform operations using the Accounts API or Payouts API for that organization by adding the on-behalf-of to the endpoints that support it.

curl --request POST \
     --url https://api.muralpay.com/api/payouts/search \
     --header 'accept: application/json' \
     --header 'authorization: Bearer $API_KEY' \
     --header 'content-type: application/json' \
     --header 'on-behalf-of: 807742f0-e76c-44cd-bbe9-30b02e0060f4'