{
  "opencollection": "1.0.0",
  "info": {
    "name": "Embedded Consumer Wallets Balances Persons API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Persons",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cadanapay.com/v1/persons/:personId",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch a person's details"
        },
        {
          "info": {
            "name": "List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cadanapay.com/v1/persons",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number to retrieve"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return per page"
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter by email"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get all persons"
        },
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cadanapay.com/v1/persons",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new employee/contractor"
        },
        {
          "info": {
            "name": "Update basic information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cadanapay.com/v1/persons/:personId/basicInfo",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update a person's basic information"
        },
        {
          "info": {
            "name": "Update personal information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cadanapay.com/v1/persons/:personId/personalInfo",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update a person's personal information including identity documents, date of birth, gender, nationality, and address"
        },
        {
          "info": {
            "name": "Get tax profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cadanapay.com/v1/persons/:personId/taxProfile",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve a person's tax profile. Returns the shape accepted by PUT /v1/persons/{personId}/taxProfile plus a server-derived `countryCode` field — remove `countryCode` before resubmitting via PUT."
        },
        {
          "info": {
            "name": "Update tax profile",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cadanapay.com/v1/persons/:personId/taxProfile",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update a person's tax profile with country-specific tax fields such as marital status and number of dependents"
        },
        {
          "info": {
            "name": "Update job information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cadanapay.com/v1/persons/:personId/jobInfo",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update a person's job information"
        },
        {
          "info": {
            "name": "Get payment information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cadanapay.com/v1/persons/:personId/paymentInfo",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetch a person's payment information"
        },
        {
          "info": {
            "name": "Update payment information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cadanapay.com/v1/persons/:personId/paymentInfo",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update a person's payment information. Required fields vary by payout corridor — use [GET /v1/payment-requirements](/api-reference/payments/resources/payment-corridor-requirements) as the authoritative list of fields for each currency and method."
        },
        {
          "info": {
            "name": "Schedule offboarding",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cadanapay.com/v1/persons/:personId/offboard",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Schedule a person for offboarding on a given exit date"
        },
        {
          "info": {
            "name": "Cancel offboarding",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cadanapay.com/v1/persons/:personId/cancelOffboarding",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Cancel a pending offboarding and return the person to active status"
        },
        {
          "info": {
            "name": "Reinstate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cadanapay.com/v1/persons/:personId/reinstate",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Reinstate a former person back to active status"
        },
        {
          "info": {
            "name": "Update person type",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cadanapay.com/v1/persons/:personId/type",
            "headers": [
              {
                "name": "X-MultiTenantKey",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the person"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Switch a person's employment type between employee and contractor. The person must be in Active status. Optionally provide new compensation info. If omitted, incompatible compensation is auto-converted (salaried becomes net, fixed becomes net)."
        }
      ]
    }
  ],
  "bundled": true
}