vaultCallback

vaultCallback

application/json

Request Body required

callback

eventStatus string

Possible values: [COMPLETED, REQUEST_AGAIN, PARTIAL]

eventType string

Possible values: [DOCUMENT_UPLOAD, DOCUMENT_APPROVAL]

token string
vaultDataRequestTypes object[]
Array [
attributes object
property name* string
copyFromPiiDataUuid string
supportedDataUuid string
]
vaultDataRequestUUID string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

Created

Unauthorized

Forbidden

Not Found

POST /v3/vault/callback

Request

Base URL

//api.mykaarma.com/pickupdelivery

Body required

{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/vault/callback' \
-H 'Content-Type: application/json' \
--data-raw '{
  "eventStatus": "COMPLETED",
  "eventType": "DOCUMENT_UPLOAD",
  "token": "string",
  "vaultDataRequestTypes": [
    {
      "attributes": {},
      "copyFromPiiDataUuid": "string",
      "supportedDataUuid": "string"
    }
  ],
  "vaultDataRequestUUID": "string"
}'