---
title: "remittance/account/profiles/add"
method: POST
path: "/remittance/account/profiles/add"
tags: ["Remittance Endpoints"]
---

# remittance/account/profiles/add

`POST /remittance/account/profiles/add`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/remittance/account/profiles/add`
- Auth: none declared

Saves a reusable tax remittance payee profile (tax category, tax account number, payer name) for the calling account, addressed by an opaque token. Supply the returned RemittanceProfileToken on /remittance/create to reuse the saved identity instead of re-typing it. If a matching TaxAccountNumber/TaxRemittanceType/client-account scope was previously saved and then deleted via /remittance/account/profiles/delete, this reactivates that same profile row rather than creating a new one - the response's RemittanceProfileToken is a brand new token, and the old (deleted) token remains permanently unresolvable.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `ClientAccountID` string: Client Account ID to scope this profile to. Omit to save an account-level profile usable with any client account (only possible for accounts with client accounts disabled - accounts with client accounts enabled must supply one).
  - `TaxRemittanceType` string, required: The remittance category this profile is saved for. See GET /remittance/tax-categories for valid options.
  - `TaxAccountNumber` string, required: The tax account number to save on this profile. Must match the tax account number format required for the selected TaxRemittanceType; federal and Quebec categories include a check digit, which is verified. An off-shape or bad-check-digit value is rejected with INVALID_PARAMETER.
  - `PayerName` string, required: The legal name of the payer to save on this profile.
  - `Nickname` string: An optional display label for this profile.
  - `DefaultDetails` string: A JSON formatted string of Details defaults to save on this profile and merge into future /remittance/create calls made with this profile's token. Every key must be a field flagged IsProfileField: true for this TaxRemittanceType in GET /remittance/tax-categories - no field is currently flagged, so any key supplied here is rejected.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `RemittanceProfileToken` string, required: Opaque 64-character token identifying the saved profile. Supply this on /remittance/create as RemittanceProfileToken to reuse the saved payee identity. Always a newly generated token, even when this call reactivated a previously deleted profile - any token you had stored for that deleted profile is now permanently unresolvable and must be replaced with this one.

---

[API](https://skmtc.dev/vopay/apis/remittance-api.md) - [All operations](https://skmtc.dev/vopay/apis/remittance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/remittance-api/revisions/d8a4c4720960?raw)