Privacy Developer API

Account
Account Holder
Card
Funding
Transaction
Status
- API status checkget

Privacy Developer API

Account
Account Holder
Card
Funding
Transaction
Status
- API status checkget

List accounts

get https://api.privacy.com/v1/accounts

List account configurations.

Query Params

begin

date-time

Date string in 8601 format. Only entries created after the specified date will be included. UTC time zone.

end

date-time

Date string in 8601 format. Only entries created before the specified date will be included. UTC time zone.

page

integer

Defaults to 1

Page (for pagination).

page_size

integer

1 to 100

Defaults to 50

Page size (for pagination).

Responses

Response body

object

data

array of objects

data

object

spend_limit

object

required

Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. Any charges to a card owned by this account will be declined once their transaction volume has surpassed the value in the applicable time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit feature is disabled.

state

string

required

Account state:

ACTIVE - Active, account is able to transact and create new cards.
PAUSED - Paused, account will not be able to transact or create new cards.

ACTIVE PAUSED

token

uuid

required

Globally unique identifier for the account. This is the same as the account_token returned by the enroll endpoint. If using this parameter, do not include pagination.

auth_rule_tokens

array of strings

List of identifiers for the Auth Rule(s) that are applied on the account.

auth_rule_tokens

page

integer

Page number.

total_entries

integer

Total number of entries.

total_pages

integer

Total number of pages.

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.


User has not been authenticated	Invalid or missing API key
API key is not active	The API key used is no longer active
Could not find API key	The API key provided is not associated with any user
Please provide API key in Authorization header	The Authorization header is not in the request
Please provide API key in the form Authorization: api-key [api-key]	The Authorization header is not formatted properly
Insufficient privileges. Issuing API key required	Write access requires an Issuing API key. Please contact api@privacy.com
Insufficient privileges to create unlocked cards.	Creating unlocked cards requires an additional privilege

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.


Rate limited, too many requests per second	User has exceeded their per second rate limit
Rate limited, reached daily limit	User has exceeded their daily rate limit
Rate limited, too many keys tried	One IP has queried too many different API keys

Response body

object

message

string

required

Explanation of error response.

debugging_request_id

uuid

required

Identifier to help debug an error.

Updated over 1 year ago

Get account

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.privacy.com/v1/accounts?page=1&page_size=50' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Get account

Did this page help you?

Privacy Developer API
Account
Update accountpatch
Get accountget
List accountsget
Account Holder
Create webhook for KYC/KYB eventspost
Check the current status of a KYC or KYB evaluationget
Resubmit account holder informationpost
Get account holder document upload statusget
Get account holder document uploadsget
Initiate account holder document uploadpost
Create an individual or business account holderpost
Card
Embedded card UIget
Reissue cardpost
Provision card (Digital Wallet)post
Update cardpatch
Get cardget
Create cardpost
List cardsget
Funding
Verify bank accountpost
Update bank accountpatch
Add funding sourcepost
List funding sourcesget
Transaction
Get transactionget
List transactionsget
Simulate void transactionpost
Simulate returnpost
Simulate clearing transactionpost
Simulate authorizationpost
Status
API status checkget

Privacy Developer API
Account
Update accountpatch
Get accountget
List accountsget
Account Holder
Create webhook for KYC/KYB eventspost
Check the current status of a KYC or KYB evaluationget
Resubmit account holder informationpost
Get account holder document upload statusget
Get account holder document uploadsget
Initiate account holder document uploadpost
Create an individual or business account holderpost
Card
Embedded card UIget
Reissue cardpost
Provision card (Digital Wallet)post
Update cardpatch
Get cardget
Create cardpost
List cardsget
Funding
Verify bank accountpost
Update bank accountpatch
Add funding sourcepost
List funding sourcesget
Transaction
Get transactionget
List transactionsget
Simulate void transactionpost
Simulate returnpost
Simulate clearing transactionpost
Simulate authorizationpost
Status
API status checkget

200OK

400A parameter in the query given in the request does not match the valid queries for the endpoint.

404The specified resource was not found.

422Unprocessable entity.