---
title: "partner/keys/add"
method: POST
path: "/partner/keys/add"
tags: ["API Key Endpoints"]
---

# partner/keys/add

`POST /partner/keys/add`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/partner/keys/add`
- Auth: none declared

This endpoint allows the user to add an API key associated to their partner account

## 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
  - `Label` string, required: The label you want associated with the key

## 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
  - `Key` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... The API Key associated with the account. Empty {} when no key is returned.
    - `0` object
      - `KeyID` integer, required: ID associated with the key. Can be used with the retrieve endpoint to get sensitive key data
      - `Label` string, required: The user submitted label for the API Key
      - `Key` string, required: The actual key value
      - `Secret` string, required: The secret associated with the key
      - `AccessScope` string, required: The scope of access associated with the key

---

[API](https://skmtc.dev/vopay/apis/integrations-and-support.md) - [All operations](https://skmtc.dev/vopay/apis/integrations-and-support/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/integrations-and-support/revisions/e88c512ce5f0?raw)