Create an application

POST

/access/applications/

POST

/access/applications/

curl -X POST https://sandbox.api.thepennyinc.com/access/applications/ \
     -H "X-Penny-As-Business: business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Daily reporting export",
  "description": "Exports settled transactions to the finance data warehouse."
}'

{
  "application": {
    "application_id": "application_01937c93-1d95-76f4-8400-1d956f44007c",
    "version": 1,
    "version_time": "2024-01-15T10:30:00Z",
    "name": "Nightly Settlement Job",
    "description": "Reconciles settlement batches with the processor each night.",
    "status": "active",
    "active": true,
    "deleted": false,
    "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
    "roles": [
      {
        "role_id": "role_019372e1-5661-79e1-83cf-56619e13cfc9",
        "role_type": "business"
      }
    ],
    "type": "machine",
    "permissions": [
      {
        "resource": "account",
        "action": "read"
      }
    ],
    "client_id": "cli_9f3a2b8e1c9d0012ab34cd"
  },
  "credentials": {
    "client_id": "string",
    "client_secret": "string"
  }
}

Create and provision a machine application for your business. The client secret is returned only in this response and is not stored by Penny.

Required permissions: permission:create.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired1-100 characters

A recognizable name for the service or integration.

descriptionstringRequired1-500 characters

What the application does and why it needs access to your Penny account.

role_idslist of stringsOptional

Custom or preset role IDs to assign to the application. An application can hold at most ten roles.

permissionslist of objectsOptional

Permissions granted directly to the application in addition to permissions inherited from roles. Every permission is scoped to your business; scope, sub-type, and resource-ID restrictions are not client-configurable.

activebooleanOptionalDefaults to true

Whether the application can request access tokens immediately after creation.

Response

The newly created application, including its one-time client secret.

applicationobject

The newly created application.

credentialsobject

The one-time credentials for the newly created application.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors