Authentication

To manage data in a vault, you need to create and authenticate a service account for the vault. See Create a Service Account for a tutorial. Once you’ve done that, you should have a Bearer Token for your service account. To authenticate your requests, simply include it as a header parameter as follows:

authorization : Bearer {BEARER_TOKEN}.

Bearer

Access token, prefixed by Bearer: Bearer <token>. Retrieved using Generate Tokens End-Point

Security Scheme Type API Key
Header parameter name: Authorization

Batch

Batch Records

Executes all APIs defined in the request (for records) in a single transaction

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID of these record)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "vaultID": "string",
  • "responses": [
    ]
}

BankAccounts

Bulk Get BankAccounts

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/bank_accounts?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete BankAccounts

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under bankAccounts needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert BankAccounts

Creates a Record for the given Vault ID & bankAccounts

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for bankAccounts)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get BankAccounts

Retrieves a Record by using Row ID of a bankAccounts

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/bank_accounts/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete BankAccounts

Deletes the object by ID for the given bankAccounts

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/bank_accounts/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update BankAccounts

Updates a Record for the given record ID , Vault ID & bankAccounts

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowbankAccountsRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}

Cards

Bulk Get Cards

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/cards?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete Cards

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under cards needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert Cards

Creates a Record for the given Vault ID & cards

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for cards)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get Cards

Retrieves a Record by using Row ID of a cards

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/cards/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete Cards

Deletes the object by ID for the given cards

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/cards/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update Cards

Updates a Record for the given record ID , Vault ID & cards

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowcardsRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}

Consumers

Bulk Get Consumers

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/consumers?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete Consumers

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under consumers needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert Consumers

Creates a Record for the given Vault ID & consumers

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for consumers)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get Consumers

Retrieves a Record by using Row ID of a consumers

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/consumers/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete Consumers

Deletes the object by ID for the given consumers

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/consumers/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update Consumers

Updates a Record for the given record ID , Vault ID & consumers

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowconsumersRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}

CreditScores

Bulk Get CreditScores

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/credit_scores?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete CreditScores

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under creditScores needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert CreditScores

Creates a Record for the given Vault ID & creditScores

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for creditScores)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get CreditScores

Retrieves a Record by using Row ID of a creditScores

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/credit_scores/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete CreditScores

Deletes the object by ID for the given creditScores

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/credit_scores/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update CreditScores

Updates a Record for the given record ID , Vault ID & creditScores

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowcreditScoresRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}

FinancialServiceProviders

Bulk Get FinancialServiceProviders

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/financial_service_providers?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete FinancialServiceProviders

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under financialServiceProviders needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert FinancialServiceProviders

Creates a Record for the given Vault ID & financialServiceProviders

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for financialServiceProviders)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get FinancialServiceProviders

Retrieves a Record by using Row ID of a financialServiceProviders

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/financial_service_providers/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete FinancialServiceProviders

Deletes the object by ID for the given financialServiceProviders

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/financial_service_providers/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update FinancialServiceProviders

Updates a Record for the given record ID , Vault ID & financialServiceProviders

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowfinancialServiceProvidersRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}

Merchants

Bulk Get Merchants

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/merchants?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete Merchants

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under merchants needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert Merchants

Creates a Record for the given Vault ID & merchants

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for merchants)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get Merchants

Retrieves a Record by using Row ID of a merchants

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/merchants/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete Merchants

Deletes the object by ID for the given merchants

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/merchants/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update Merchants

Updates a Record for the given record ID , Vault ID & merchants

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowmerchantsRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}

Query

Query Record

Retrieves Records by using the query provided

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under for which the query should be run)
query
string (The query to fire)

Responses

Request samples

Content type
application/json
{
  • "query": "select * from persons where skyflow_id='04c1feec-fda0-11ea-b6ad-a683e75f717a'"
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Tokens

Bulk Get Record By Tokens

Retrieves all records using the token IDs

Authorizations:
path Parameters
vaultID
required
string
query Parameters
token_ids
Array of strings

List of Token IDs who's records needs to be fetched.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/tokens?token_ids=string&redaction=DEFAULT' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get Record By Token

Retrieves a Record by using Token ID

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/tokens/:ID?redaction=DEFAULT' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "token_id": "b8e920d4-0f70-11eb-91f2-0242ac10ee0c",
  • "fields": {
    }
}

Transactions

Bulk Get Transactions

Gets records matching the ID's

Authorizations:
path Parameters
vaultID
required
string
query Parameters
skyflow_ids
Array of strings

List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id.

redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.

offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/transactions?skyflow_ids=string&redaction=DEFAULT&tokenization=true&fields=string&offset=0&limit=25' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Bulk Delete Transactions

Deletes records matching the ID's or all records if '*' is provided as the ID

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID Under from which these records needs to be deleted)
skyflow_ids
Array of strings (List of Record IDs that needs to be deleted or '*' if all records under transactions needs to be deleted)

Responses

Request samples

Content type
application/json
{
  • "vaultID": "string",
  • "skyflow_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "RecordIDResponse": [
    ]
}

Insert Transactions

Creates a Record for the given Vault ID & transactions

Authorizations:
path Parameters
vaultID
required
string
Request Body schema: application/json
vaultID
string (Vault ID for transactions)
Array of objects (The list of records)

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Get Transactions

Retrieves a Record by using Row ID of a transactions

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
query Parameters
redaction
string
Default: "DEFAULT"
Enum: "DEFAULT" "REDACTED" "MASKED" "PLAIN_TEXT"

Redaction level to enforce on the data in response.

tokenization
boolean <boolean>

If 'true' tokens are returned.

fields
Array of strings

Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched.

Responses

Request samples

curl -i -X GET \
  'https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/transactions/:ID?redaction=DEFAULT&tokenization=true&fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "fields": {
    }
}

Delete Transactions

Deletes the object by ID for the given transactions

Authorizations:
path Parameters
vaultID
required
string
ID
required
string

Responses

Request samples

curl -i -X DELETE \
  https://workspace-name.account-name.vault.skyflowapis.com/v1/vaults/:vaultID/transactions/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "skyflow_id": "string",
  • "deleted": true
}

Update Transactions

Updates a Record for the given record ID , Vault ID & transactions

Authorizations:
path Parameters
vaultID
required
string
ID
required
string
Request Body schema: application/json
ID
string (ID of the Record to Fetch)
vaultID
string (Vault ID Under for this record)
object (skyflowtransactionsRecords)

Responses

Request samples

Content type
application/json
{
  • "record": {
    }
}

Response samples

Content type
application/json
{
  • "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md",
  • "updatedTime": "2017-07-21T00:56:36.000Z"
}