> ## Documentation Index
> Fetch the complete documentation index at: https://www.dropfans.io/developers/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/external/payouts/masspay/profile — MassPay payout profile

> The MassPay payout profile behind the payout wallet, read live from MassPay, with the required fields it still lacks in `missingFields`.

- Source: https://www.dropfans.io/developers/reference/get-masspay-profile
- Section: API reference
- OpenAPI: https://www.dropfans.io/developers/openapi.json

The MassPay payout profile behind the payout wallet, read live from MassPay, with the required fields it still lacks in `missingFields`.

Before the payee exists (`provisioned: false`) the profile is a prefill from the account (name, e-mail, country) for your form. A payee created automatically at the ID check often has no address yet: `missingFields` then lists what [POST /payouts/masspay/profile](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md) has to send. Personal data — the key's own account only.

> [!NOTE] Dropfans-operated integrations only, for now
> At launch this endpoint answers 403 `first_party_only` to every other app. The read endpoints of this group are open to every key.

## Authentication

`Authorization: Bearer dpfn_...` — an API key generated in the dashboard (Vault → API Connect). By default the key acts for the one account it belongs to. Missing or invalid keys return 401 `{"error":"Unauthorized","code":"unauthorized"}`.

## Responses

### 200

The profile.

| Field | Type | Required | Description |
|---|---|---|---|
| `provisioned` | boolean | yes | True once the payee exists at MassPay. |
| `status` | string \\| null |  | MassPay’s status for the payee (e.g. ACTIVE). Null before it exists. |
| `missingFields` | string[] | yes | Required fields blank at MassPay. Empty when complete (and before the payee exists). |
| `profile` | MasspayProfile | yes | The values. Blank fields are empty strings. |

```json
{
  "provisioned": true,
  "status": "ACTIVE",
  "missingFields": [
    "address1",
    "city",
    "stateProvince",
    "postalCode"
  ],
  "profile": {
    "accountType": "INDIVIDUAL",
    "businessName": "",
    "firstName": "Jane",
    "middleName": "",
    "lastName": "Doe",
    "email": "jane@example.com",
    "mobileNumber": "46701234567",
    "language": "en",
    "dateOfBirth": "1994-05-17",
    "country": "SWE",
    "address1": "",
    "address2": "",
    "city": "",
    "stateProvince": "",
    "postalCode": ""
  }
}
```

## Errors

| Status | Body | When |
|---|---|---|
| 401 | `{"error":"Unauthorized","code":"unauthorized"}` | Missing or invalid API key. |
| 403 | `{"error":"Payout methods need the account’s own key — a key an agency minted for a managed account cannot read or change where payouts go.","code":"agency_key_not_allowed"}` | The key was minted by an agency for an account it manages. |
| 403 | `{"error":"This endpoint is only available to Dropfans-operated integrations.","code":"first_party_only"}` | During launch, payout-method endpoints are open to Dropfans-operated integrations only. |
| 502 | `{"error":"Could not read your MassPay profile. Try again in a moment.","code":"masspay_unavailable"}` | MassPay did not answer. Retry. |
| 503 | `{"error":"MassPay is not available right now.","code":"not_configured"}` | MassPay payouts are switched off on this environment. |
| 400 | `{"error":"This endpoint only acts as the key’s own account — send it without X-Dropfans-Account.","code":"account_header_not_allowed"}` | `X-Dropfans-Account` names another account. An agency can never change where a creator it manages is paid. |

## Rate limiting

Per-key fixed windows by tier (Personal 60/min · 5,000/day; approved apps 300/min · 50,000/day; Dropfans-operated integrations exempt). Read the live values from X-RateLimit-Tier, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and their -Day variants; a 429 carries Retry-After and `{"error":"Rate limit exceeded","code":"rate_limited"}`. See [Rate limits](https://www.dropfans.io/developers/concepts/rate-limits.md).

## Code samples

### curl

```bash
curl "https://www.dropfans.io/api/external/payouts/masspay/profile" \
  -H "Authorization: Bearer $DROPFANS_API_KEY"
```

### Node

```javascript
const res = await fetch(`https://www.dropfans.io/api/external/payouts/masspay/profile`, {
  headers: {
    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
  },
});
console.log(await res.json());
```

### Python

```python
import os
import requests

res = requests.get(
    "https://www.dropfans.io/api/external/payouts/masspay/profile",
    headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
)
print(res.json())
```

## OpenAPI

```json
{
  "method": "GET",
  "path": "/api/external/payouts/masspay/profile",
  "operationId": "getMasspayProfile",
  "tags": [
    "payouts"
  ],
  "summary": "MassPay payout profile",
  "description": "The MassPay payout profile behind the payout wallet, read live from MassPay, with the required fields it still lacks in `missingFields`.\n\nBefore the payee exists (`provisioned: false`) the profile is a prefill from the account (name, e-mail, country) for your form. A payee created automatically at the ID check often has no address yet: `missingFields` then lists what [POST /payouts/masspay/profile](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md) has to send. Personal data — the key's own account only.\n\n> [!NOTE] Dropfans-operated integrations only, for now\n> At launch this endpoint answers 403 `first_party_only` to every other app. The read endpoints of this group are open to every key.",
  "responses": {
    "200": {
      "description": "The profile.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-Dropfans-Account": {
          "description": "The id of the account this request acted on — the key’s own account, or the managed account named in the X-Dropfans-Account request header. Assert it when acting for several accounts.",
          "schema": {
            "type": "string"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "provisioned": {
                "type": "boolean",
                "description": "True once the payee exists at MassPay."
              },
              "status": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "MassPay’s status for the payee (e.g. ACTIVE). Null before it exists."
              },
              "missingFields": {
                "type": "array",
                "items": {
                  "type": "string",
                  "description": "A profile field name.",
                  "enum": [
                    "businessName",
                    "firstName",
                    "middleName",
                    "lastName",
                    "email",
                    "mobileNumber",
                    "language",
                    "dateOfBirth",
                    "country",
                    "address1",
                    "address2",
                    "city",
                    "stateProvince",
                    "postalCode"
                  ]
                },
                "description": "Required fields blank at MassPay. Empty when complete (and before the payee exists)."
              },
              "profile": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "type": "string",
                    "description": "BUSINESS when MassPay holds a legal business name for the payee.",
                    "enum": [
                      "INDIVIDUAL",
                      "BUSINESS"
                    ]
                  },
                  "businessName": {
                    "type": "string",
                    "description": "Legal business name. Empty string when not set. Business accounts only.",
                    "example": "Jane Doe Media AB"
                  },
                  "firstName": {
                    "type": "string",
                    "description": "First name. Empty string when not set. Required for a payout.",
                    "example": "Jane"
                  },
                  "middleName": {
                    "type": "string",
                    "description": "Middle name. Empty string when not set. Optional."
                  },
                  "lastName": {
                    "type": "string",
                    "description": "Last name. Empty string when not set. Required for a payout.",
                    "example": "Doe"
                  },
                  "email": {
                    "type": "string",
                    "description": "Email. Empty string when not set. Required for a payout.",
                    "example": "jane@example.com"
                  },
                  "mobileNumber": {
                    "type": "string",
                    "description": "Mobile number. Empty string when not set. Optional.",
                    "example": "+46 70 123 45 67"
                  },
                  "language": {
                    "type": "string",
                    "description": "Language. Empty string when not set. Optional.",
                    "example": "en"
                  },
                  "dateOfBirth": {
                    "type": "string",
                    "description": "Date of birth. Empty string when not set. Optional.",
                    "example": "1994-05-17"
                  },
                  "country": {
                    "type": "string",
                    "description": "Country. Empty string when not set. Required for a payout.",
                    "example": "SWE"
                  },
                  "address1": {
                    "type": "string",
                    "description": "Address line 1. Empty string when not set. Required for a payout.",
                    "example": "Storgatan 1"
                  },
                  "address2": {
                    "type": "string",
                    "description": "Address line 2. Empty string when not set. Optional."
                  },
                  "city": {
                    "type": "string",
                    "description": "City. Empty string when not set. Required for a payout.",
                    "example": "Stockholm"
                  },
                  "stateProvince": {
                    "type": "string",
                    "description": "State / province. Empty string when not set. Required for a payout.",
                    "example": "Stockholm County"
                  },
                  "postalCode": {
                    "type": "string",
                    "description": "Postal code. Empty string when not set. Required for a payout.",
                    "example": "111 22"
                  }
                },
                "required": [
                  "accountType",
                  "businessName",
                  "firstName",
                  "middleName",
                  "lastName",
                  "email",
                  "mobileNumber",
                  "language",
                  "dateOfBirth",
                  "country",
                  "address1",
                  "address2",
                  "city",
                  "stateProvince",
                  "postalCode"
                ]
              }
            },
            "required": [
              "provisioned",
              "missingFields",
              "profile"
            ]
          },
          "example": {
            "provisioned": true,
            "status": "ACTIVE",
            "missingFields": [
              "address1",
              "city",
              "stateProvince",
              "postalCode"
            ],
            "profile": {
              "accountType": "INDIVIDUAL",
              "businessName": "",
              "firstName": "Jane",
              "middleName": "",
              "lastName": "Doe",
              "email": "jane@example.com",
              "mobileNumber": "46701234567",
              "language": "en",
              "dateOfBirth": "1994-05-17",
              "country": "SWE",
              "address1": "",
              "address2": "",
              "city": "",
              "stateProvince": "",
              "postalCode": ""
            }
          }
        }
      }
    },
    "400": {
      "description": "`X-Dropfans-Account` names another account. An agency can never change where a creator it manages is paid.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "This endpoint only acts as the key’s own account — send it without X-Dropfans-Account.",
            "code": "account_header_not_allowed"
          }
        }
      }
    },
    "401": {
      "description": "Missing or invalid API key.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "Unauthorized",
            "code": "unauthorized"
          }
        }
      }
    },
    "403": {
      "description": "The key was minted by an agency for an account it manages. Also: During launch, payout-method endpoints are open to Dropfans-operated integrations only.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "Payout methods need the account’s own key — a key an agency minted for a managed account cannot read or change where payouts go.",
            "code": "agency_key_not_allowed"
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded for the current minute or day window. Wait Retry-After seconds and retry.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "Retry-After": {
          "description": "Seconds to wait before retrying (sent with 429s).",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "Rate limit exceeded",
            "code": "rate_limited"
          }
        }
      }
    },
    "502": {
      "description": "MassPay did not answer. Retry.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "Could not read your MassPay profile. Try again in a moment.",
            "code": "masspay_unavailable"
          }
        }
      }
    },
    "503": {
      "description": "MassPay payouts are switched off on this environment.",
      "headers": {
        "X-RateLimit-Tier": {
          "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).",
          "schema": {
            "type": "string",
            "enum": [
              "personal",
              "app",
              "first_party"
            ]
          }
        },
        "X-RateLimit-Limit": {
          "description": "Requests allowed per minute for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining": {
          "description": "Requests left in the current minute window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset": {
          "description": "Epoch seconds when the minute window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Limit-Day": {
          "description": "Requests allowed per UTC day for this key (absent on first_party).",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Remaining-Day": {
          "description": "Requests left in the current UTC day window.",
          "schema": {
            "type": "integer"
          }
        },
        "X-RateLimit-Reset-Day": {
          "description": "Epoch seconds when the day window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Human-readable message.",
                "example": "Rate limit exceeded"
              },
              "code": {
                "type": "string",
                "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.",
                "example": "rate_limited"
              }
            },
            "required": [
              "error",
              "code"
            ]
          },
          "example": {
            "error": "MassPay is not available right now.",
            "code": "not_configured"
          }
        }
      }
    }
  },
  "x-codeSamples": [
    {
      "lang": "cURL",
      "label": "curl",
      "source": "curl \"https://www.dropfans.io/api/external/payouts/masspay/profile\" \\\n  -H \"Authorization: Bearer $DROPFANS_API_KEY\""
    },
    {
      "lang": "JavaScript",
      "label": "Node",
      "source": "const res = await fetch(`https://www.dropfans.io/api/external/payouts/masspay/profile`, {\n  headers: {\n    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n  },\n});\nconsole.log(await res.json());"
    },
    {
      "lang": "Python",
      "source": "import os\nimport requests\n\nres = requests.get(\n    \"https://www.dropfans.io/api/external/payouts/masspay/profile\",\n    headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n)\nprint(res.json())"
    }
  ],
  "x-dropfans-docs": "https://www.dropfans.io/developers/reference/get-masspay-profile"
}
```

---

Previous: [Remove a payout method](https://www.dropfans.io/developers/reference/delete-payout-method.md) · Next: [Set up the MassPay wallet](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)