API docs by Redocly

YourOwn Partner API (0.3.0)

Download OpenAPI specification:

YourOwn Support: support@yourownwallet.com

The YourOwn Partner API empowers banks, financial institutions, and wallet providers to streamline financial onboarding, loan applications, and client servicing. By embedding YourOwn's financial identity solution, partners can enable a 1-click process that delivers a fast, complete, accurate, and secure view of a customer's financial data—reducing processing times, improving risk assessment, and enhancing user experience.

Capabilities

Fast 🏁

Transform the cumbersome process of gathering financial data into a 1-click experience, redirecting customers to a secure flow that aggregates bank, investment, crypto holdings, and tax records, cutting processing times, boosting customer satisfaction and completion rates.

Complete 💯

Partners can define exact data requirements (e.g., bank accounts, tax records), ensuring all necessary data and documents are collected in one seamless step, reducing incomplete submissions, minimizing applicant drop-offs, and streamlining operations with a single button click.

Accurate ✅

YourOwn ensures precision by retrieving financial data from financial institutions and digital asset networks like Bitcoin to minimize errors and enhance decision-making to reduce risks. Linked data is compliant with lending and verification standards like Fannie Mae, Freddie Mac, Plaid and Hoseki.

Secure 🔒

With secured API interactions, asymmetric encryption (data encrypted with the recipient's public key) and on-device encryption using keys from a user-owned seed phrase, YourOwn ensures zero-knowledge privacy—protecting against fraud, ensuring compliance, and fostering customer trust by limiting access to authorized recipients.

Encrypted Data

YourOwn ensures that financial data is secure and can only be viewed by the user and their target data recipient. Data is secured by asymmetric encryption performed on the client device and cannot be decrypted by YourOwn. There are two places where data must be decrypted to be viewed

  1. Package/Update JSON Data
  2. Package/Update Zip files

For clients using the SDK data will be decrypted automatically.

Encrypted Zip Files

Packages and updates contain download links for an encrypted zip file. The links are temporary and must be downloaded immediately. Once downloaded the data must be decrypted to convert it to a zip file. Once decrypted the zip file will have the following structure.

├─ Financial Institutions/
│  ├── American Express/
│  │   └── American Express-10-15-2025-Asset Report-90-days.pdf
│  ├── Chase/
│  │   └── Chase-10-15-2025-Asset Report-45-days.pdf
├─ Tax/
│  ├── W2s/
│  │   └── 2024-W2-example.pdf
│  ├── 1099s/
│  │   └── 2024-1099-MISC-example.pdf
│  ├── Schedules/
│  │   └── 2024-schedule.pdf
│  ├── Returns/
│  │   └── 2024-1040.pdf
│  ├── Other/
│  │   └── 2024-charitable-donations.pdf
├─ ID/
│  ├── license.png
│  ├── identity.txt
│  └── identity.png
└─ Income/
   ├── ADP/
   │   ├── 2021-12 ADP - Payroll-w2.pdf
   │   └── 2022-12 ADP - Payroll-w2.pdf
   ├── Chase/
   │   └── Chase-10-2025-Bank Income Report.pdf
   ├── Navy Federal/
   │   └── Navy Federal-10-2025-Bank Income Report.pdf
   └── Other Partner/
       ├─ 90cfa3ea-1761-44e4-a95a-4dee489ed235.pdf
       ├─ 12417c98-d4b3-4716-bfda-f646d2b4b4eb.pdf
       └─ 62760b07-9897-4912-8247-8613a3a78127.pdf

Encrypted JSON

In addition to the encrypted zip the API also returns an encrypted JSON payload available via a short-lived presigned download URL. The data will be automatically downloaded and decrypted by the SDK.

{
  "crypto": [
    {
      "institution": "YourOwn Coins",
      "accounts": [
        {
          "name": "YourOwn Circle Account",
          "balance": 100,
          "currency": USDC,
          "date": "2023-03-30T18:27:37Z"
        },
        {
          "name": "YourOwn Bitcoin Account",
          "balance": 105,
          "currency": BTC,
          "date": "2023-03-30T18:30:32Z"
        }
      ]
    }
  ],
  "income": [
    {
      "bank_income": [
        {
          "bank_income_id": "dacc92a0-cb59-43a5-ba24-1b1c07a03f28",
          "bank_income_summary": {
            "end_date": "2024-08-21",
            "historical_summary": [
              {
                "end_date": "2024-08-21",
                "iso_currency_code": "USD",
                "start_date": "2024-08-06",
                "total_amount": 4090.14,
                "total_amounts": [
                  {
                    "amount": 4090.14,
                    "iso_currency_code": "USD",
                    "unofficial_currency_code": null
                  }
                ],
                "transactions": [
                  {
                    "amount": 120.12,
                    "check_number": null,
                    "date": "2024-08-07",
                    "iso_currency_code": "USD",
                    "name": "TEXAS OAG CHILD SUPPORT",
                    "original_description": "TEXAS OAG CHILD SUPPORT",
                    "transaction_id": "EZMmvwREqlSGmlRam7bzFKyBll3kJjU4xKm1w",
                    "unofficial_currency_code": null
                  },
                  {
                    "amount": 1525,
                    "check_number": null,
                    "date": "2024-08-08",
                    "iso_currency_code": "USD",
                    "name": "AIRBNB PAYMENTS PPD ID: 1234567890",
                    "original_description": "AIRBNB PAYMENTS PPD ID: 1234567890",
                    "transaction_id": "Wr6jzLwg1qs6ag9Xa8BrCpBAPPxnEXF6ZmjDR",
                    "unofficial_currency_code": null
                  },
                ],
                "unofficial_currency_code": null
              }
            ],
            "income_categories_count": 5,
            "income_sources_count": 5,
            "income_transactions_count": 6,
            "iso_currency_code": "USD",
            "start_date": "2024-08-07",
            "total_amount": 4090.14,
            "total_amounts": [
              {
                "amount": 4090.14,
                "iso_currency_code": "USD",
                "unofficial_currency_code": null
              }
            ],
            "unofficial_currency_code": null
          },
          "days_requested": 15,
          "generated_time": "2024-08-21T18:10:46.293199Z",
          "items": [
            {
              "bank_income_accounts": [
                {
                  "account_id": "G1L9oybBrKSMPmBdPzXoFN8oo16rqqC6PwkA5",
                  "mask": "9217",
                  "name": "Checking",
                  "official_name": "Plaid checking",
                  "owners": [
                    {
                      "addresses": [],
                      "emails": [],
                      "names": [
                        "Jane Doe"
                      ],
                      "phone_numbers": []
                    }
                  ],
                  "subtype": "checking",
                  "type": "depository"
                }
              ],
              "bank_income_sources": [
                {
                  "account_id": "G1L9oybBrKSMPmBdPzXoFN8oo16rqqC6PwkA5",
                  "end_date": "2024-08-15",
                  "historical_summary": [
                    {
                      "end_date": "2024-08-21",
                      "iso_currency_code": "USD",
                      "start_date": "2024-08-06",
                      "total_amount": 1000.7,
                      "total_amounts": [
                        {
                          "amount": 1000.7,
                          "iso_currency_code": "USD",
                          "unofficial_currency_code": null
                        }
                      ],
                      "transactions": [
                        {
                          "amount": 1000.7,
                          "check_number": null,
                          "date": "2024-08-15",
                          "iso_currency_code": "USD",
                          "name": "PLAID PAYROLL",
                          "original_description": "PLAID PAYROLL",
                          "transaction_id": "G1L9oybBrKSMPmBdPzXoFN8aGGE7gXC6MeoQB",
                          "unofficial_currency_code": null
                        }
                      ],
                      "unofficial_currency_code": null
                    }
                  ],
                  "income_category": "SALARY",
                  "income_description": "PLAID PAYROLL",
                  "income_source_id": "0e9d6fbc-29de-4225-9843-2f71e02a54d1",
                  "pay_frequency": "UNKNOWN",
                  "start_date": "2024-08-15",
                  "total_amount": 1000.7,
                  "transaction_count": 1
                },
                {
                  "account_id": "G1L9oybBrKSMPmBdPzXoFN8oo16rqqC6PwkA5",
                  "end_date": "2024-08-15",
                  "historical_summary": [
                    {
                      "end_date": "2024-08-21",
                      "iso_currency_code": "USD",
                      "start_date": "2024-08-06",
                      "total_amount": 824.2,
                      "total_amounts": [
                        {
                          "amount": 824.2,
                          "iso_currency_code": "USD",
                          "unofficial_currency_code": null
                        }
                      ],
                      "transactions": [
                        {
                          "amount": 824.2,
                          "check_number": null,
                          "date": "2024-08-15",
                          "iso_currency_code": "USD",
                          "name": "SSI TREAS 310 XXSUPP SEC PPD ID: 1234567890",
                          "original_description": "SSI TREAS 310 XXSUPP SEC PPD ID: 1234567890",
                          "transaction_id": "nWLlwMm1qxi8DomvDXP3FaGjXX5bm9TAlyQnk",
                          "unofficial_currency_code": null
                        }
                      ],
                      "unofficial_currency_code": null
                    }
                  ],
                  "income_category": "LONG_TERM_DISABILITY",
                  "income_description": "SSI TREAS 310 XXSUPP SEC PPD ID: 1234567890",
                  "income_source_id": "88bc00d8-2bb1-42d0-a054-db3f20948283",
                  "pay_frequency": "UNKNOWN",
                  "start_date": "2024-08-15",
                  "total_amount": 824.2,
                  "transaction_count": 1
                },
                {
                  "account_id": "G1L9oybBrKSMPmBdPzXoFN8oo16rqqC6PwkA5",
                  "end_date": "2024-08-08",
                  "historical_summary": [
                    {
                      "end_date": "2024-08-21",
                      "iso_currency_code": "USD",
                      "start_date": "2024-08-06",
                      "total_amount": 1525,
                      "total_amounts": [
                        {
                          "amount": 1525,
                          "iso_currency_code": "USD",
                          "unofficial_currency_code": null
                        }
                      ],
                      "transactions": [
                        {
                          "amount": 1525,
                          "check_number": null,
                          "date": "2024-08-08",
                          "iso_currency_code": "USD",
                          "name": "AIRBNB PAYMENTS PPD ID: 1234567890",
                          "original_description": "AIRBNB PAYMENTS PPD ID: 1234567890",
                          "transaction_id": "Wr6jzLwg1qs6ag9Xa8BrCpBAPPxnEXF6ZmjDR",
                          "unofficial_currency_code": null
                        }
                      ],
                      "unofficial_currency_code": null
                    }
                  ],
                  "income_category": "RENTAL",
                  "income_description": "AIRBNB PAYMENTS PPD ID: 1234567890",
                  "income_source_id": "063689af-7299-4327-b71f-9d8849a40c0e",
                  "pay_frequency": "UNKNOWN",
                  "start_date": "2024-08-08",
                  "total_amount": 1525,
                  "transaction_count": 1
                },
                {
                  "account_id": "G1L9oybBrKSMPmBdPzXoFN8oo16rqqC6PwkA5",
                  "end_date": "2024-08-12",
                  "historical_summary": [
                    {
                      "end_date": "2024-08-21",
                      "iso_currency_code": "USD",
                      "start_date": "2024-08-06",
                      "total_amount": 500,
                      "total_amounts": [
                        {
                          "amount": 500,
                          "iso_currency_code": "USD",
                          "unofficial_currency_code": null
                        }
                      ],
                      "transactions": [
                        {
                          "amount": 500,
                          "check_number": null,
                          "date": "2024-08-12",
                          "iso_currency_code": "USD",
                          "name": "TWC-BENEFITS/UI BENEFIT",
                          "original_description": "TWC-BENEFITS/UI BENEFIT",
                          "transaction_id": "Aj7Apx5bDyIA3VRl35yqC18wXXorBgI9rX5dp",
                          "unofficial_currency_code": null
                        }
                      ],
                      "unofficial_currency_code": null
                    }
                  ],
                  "income_category": "UNEMPLOYMENT",
                  "income_description": "TWC-BENEFITS/UI BENEFIT",
                  "income_source_id": "ce160170-49d0-4811-b58e-cb4878d05f83",
                  "pay_frequency": "UNKNOWN",
                  "start_date": "2024-08-12",
                  "total_amount": 500,
                  "transaction_count": 1
                },
                {
                  "account_id": "G1L9oybBrKSMPmBdPzXoFN8oo16rqqC6PwkA5",
                  "end_date": "2024-08-21",
                  "historical_summary": [
                    {
                      "end_date": "2024-08-21",
                      "iso_currency_code": "USD",
                      "start_date": "2024-08-06",
                      "total_amount": 240.24,
                      "total_amounts": [
                        {
                          "amount": 240.24,
                          "iso_currency_code": "USD",
                          "unofficial_currency_code": null
                        }
                      ],
                      "transactions": [
                        {
                          "amount": 120.12,
                          "check_number": null,
                          "date": "2024-08-07",
                          "iso_currency_code": "USD",
                          "name": "TEXAS OAG CHILD SUPPORT",
                          "original_description": "TEXAS OAG CHILD SUPPORT",
                          "transaction_id": "EZMmvwREqlSGmlRam7bzFKyBll3kJjU4xKm1w",
                          "unofficial_currency_code": null
                        },
                        {
                          "amount": 120.12,
                          "check_number": null,
                          "date": "2024-08-21",
                          "iso_currency_code": "USD",
                          "name": "TEXAS OAG CHILD SUPPORT",
                          "original_description": "TEXAS OAG CHILD SUPPORT",
                          "transaction_id": "b7dkg6eQbPFQeRvVeZlxcqxZooa7nWSmb47dj",
                          "unofficial_currency_code": null
                        }
                      ],
                      "unofficial_currency_code": null
                    }
                  ],
                  "income_category": "CHILD_SUPPORT",
                  "income_description": "TEXAS OAG CHILD SUPPORT",
                  "income_source_id": "c8e1576e-9de4-47b4-ad55-3f7b068cc863",
                  "pay_frequency": "UNKNOWN",
                  "start_date": "2024-08-07",
                  "total_amount": 240.24,
                  "transaction_count": 2
                }
              ],
              "institution_id": "ins_20",
              "institution_name": "Citizens Bank",
              "item_id": "L8EKo4GydxSKmJQGmXyPuDkeNn4rg9fP3MKLv",
              "last_updated_time": "2024-08-21T18:10:47.367335Z"
            }
          ]
        }
      ],
    }
  ],
  "reports": [
    {
      "asset_report_id": "028e8404-a013-4a45-ac9e-002482f9cafc",
      "client_report_id": "client_report_id_1221",
      "date_generated": "2023-03-30T18:27:37Z",
      "days_requested": 90,
      "items": [
        {
          "accounts": [
            {
              "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",
              "balances": {
                "available": 43200,
                "current": 43200,
                "limit": null,
                "margin_loan_amount": null,
                "iso_currency_code": "USD",
                "unofficial_currency_code": null
              },
              "days_available": 90,
              "historical_balances": [
                {
                  "current": 49050,
                  "date": "2023-03-29",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": 49050,
                  "date": "2023-03-28",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": 49050,
                  "date": "2023-03-27",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": 49050,
                  "date": "2023-03-26",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": 49050,
                  "date": "2023-03-25",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ],
              "mask": "4444",
              "name": "Plaid Money Market",
              "official_name": "Plaid Platinum Standard 1.85% Interest Money Market",
              "owners": [
                {
                  "addresses": [
                    {
                      "data": {
                        "city": "Malakoff",
                        "country": "US",
                        "region": "NY",
                        "street": "2992 Cameron Road",
                        "postal_code": "14236"
                      },
                      "primary": true
                    },
                    {
                      "data": {
                        "city": "San Matias",
                        "country": "US",
                        "region": "CA",
                        "street": "2493 Leisure Lane",
                        "postal_code": "93405-2255"
                      },
                      "primary": false
                    }
                  ],
                  "emails": [
                    {
                      "data": "accountholder0@example.com",
                      "primary": true,
                      "type": "primary"
                    },
                    {
                      "data": "accountholder1@example.com",
                      "primary": false,
                      "type": "secondary"
                    },
                    {
                      "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                      "primary": false,
                      "type": "other"
                    }
                  ],
                  "names": [
                    "Alberta Bobbeth Charleson"
                  ],
                  "phone_numbers": [
                    {
                      "data": "+1 111-555-3333",
                      "primary": false,
                      "type": "home"
                    },
                    {
                      "data": "+1 111-555-4444",
                      "primary": false,
                      "type": "work"
                    },
                    {
                      "data": "+1 111-555-5555",
                      "primary": false,
                      "type": "mobile"
                    }
                  ]
                }
              ],
              "ownership_type": null,
              "subtype": "money market",
              "transactions": [
                {
                  "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",
                  "amount": 5850,
                  "date": "2023-03-30",
                  "iso_currency_code": "USD",
                  "original_description": "ACH Electronic CreditGUSTO PAY 123456",
                  "pending": false,
                  "transaction_id": "gGQgjoeyqBF89PND6K14Sow1wddZBmtLomJ78",
                  "unofficial_currency_code": null
                }
              ],
              "type": "depository"
            },
            {
              "account_id": "eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v",
              "balances": {
                "available": 100,
                "current": 110,
                "limit": null,
                "margin_loan_amount": null,
                "iso_currency_code": "USD",
                "unofficial_currency_code": null
              },
              "days_available": 90,
              "historical_balances": [
                {
                  "current": 110,
                  "date": "2023-03-29",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": -390,
                  "date": "2023-03-28",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": -373.67,
                  "date": "2023-03-27",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": -284.27,
                  "date": "2023-03-26",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                {
                  "current": -284.27,
                  "date": "2023-03-25",
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ],
              "mask": "0000",
              "name": "Plaid Checking",
              "official_name": "Plaid Gold Standard 0% Interest Checking",
              "owners": [
                {
                  "addresses": [
                    {
                      "data": {
                        "city": "Malakoff",
                        "country": "US",
                        "region": "NY",
                        "street": "2992 Cameron Road",
                        "postal_code": "14236"
                      },
                      "primary": true
                    },
                    {
                      "data": {
                        "city": "San Matias",
                        "country": "US",
                        "region": "CA",
                        "street": "2493 Leisure Lane",
                        "postal_code": "93405-2255"
                      },
                      "primary": false
                    }
                  ],
                  "emails": [
                    {
                      "data": "accountholder0@example.com",
                      "primary": true,
                      "type": "primary"
                    },
                    {
                      "data": "accountholder1@example.com",
                      "primary": false,
                      "type": "secondary"
                    },
                    {
                      "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                      "primary": false,
                      "type": "other"
                    }
                  ],
                  "names": [
                    "Alberta Bobbeth Charleson"
                  ],
                  "phone_numbers": [
                    {
                      "data": "+1 111-555-3333",
                      "primary": false,
                      "type": "home"
                    },
                    {
                      "data": "+1 111-555-4444",
                      "primary": false,
                      "type": "work"
                    },
                    {
                      "data": "+1 111-555-5555",
                      "primary": false,
                      "type": "mobile"
                    }
                  ]
                }
              ],
              "ownership_type": null,
              "subtype": "checking",
              "transactions": [
                {
                  "account_id": "eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v",
                  "amount": 89.4,
                  "date": "2023-03-27",
                  "iso_currency_code": "USD",
                  "original_description": "SparkFun",
                  "pending": false,
                  "transaction_id": "4zBRq1Qem4uAPnoyKjJNTRQpQddM4ztlo1PLD",
                  "unofficial_currency_code": null
                },
                {
                  "account_id": "eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v",
                  "amount": 12,
                  "date": "2023-03-28",
                  "iso_currency_code": "USD",
                  "original_description": "McDonalds #3322",
                  "pending": false,
                  "transaction_id": "dkjL41PnbKsPral79jpxhMWdW55gkPfBkWpRL",
                  "unofficial_currency_code": null
                },
                {
                  "account_id": "eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v",
                  "amount": 4.33,
                  "date": "2023-03-28",
                  "iso_currency_code": "USD",
                  "original_description": "Starbucks",
                  "pending": false,
                  "transaction_id": "a84ZxQaWDAtDL3dRgmazT57K7jjN3WFkNWMDy",
                  "unofficial_currency_code": null
                },
                {
                  "account_id": "eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v",
                  "amount": -500,
                  "date": "2023-03-29",
                  "iso_currency_code": "USD",
                  "original_description": "United Airlines **** REFUND ****",
                  "pending": false,
                  "transaction_id": "xG9jbv3eMoFWepzB7wQLT3LoLggX5Duy1Gbe5",
                  "unofficial_currency_code": null
                }
              ],
              "type": "depository"
            }
          ],
          "date_last_updated": "2023-03-30T18:25:26Z",
          "institution_id": "ins_109508",
          "institution_name": "First Platypus Bank",
          "item_id": "AZMP7JrGXgtPd3AQMeg7hwMKgk5E8qU1V5ME7"
        }
      ],
      "user": {
        "client_user_id": "uid_40332",
        "email": "abcharleston@example.com",
        "first_name": "Anna",
        "last_name": "Charleston",
        "middle_name": "B",
        "phone_number": "1-415-867-5309",
        "ssn": "111-22-1234"
      }
    },
  ]
}

Company

Company defines how your company will show up in the consumer application.

Add company data

Company data is used to display your information and logo in the YourOwn Wallet app when customers are submitting packages.

Authorizations:
BasicAuth
Request Body schema: application/json
required
name
required
string

A name to display in the app for your company

description
string
logo
required
string (Logo)

A base64 encoded version of your logo preferably 128x128px

object (CompanySettings)

Responses

Request samples

Content type
application/json
{
  • "name": "Michigan Rentals",
  • "description": "Apply for your next rental with Michigan's most trusted property manager",
  • "logo": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSgBBwcHCggKEwoKEygaFhooKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKP/AABEIAIAAgAMBEQACEQEDEQH/xAGiAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgsQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+gEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoLEQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/APqmgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKAPn34rftBQaRdTaV4Kjt765QlZb+T5oUPQiMD75/2s7eOjZraFK+rIcux5Efjr8RN+7+31xn7v2K3x/6BmtPZx7C5mbelftE+OYF8uSLS9Qc95rVg3/kNlH6UnSiHMx2qftFeOZk8tLfSbB/70Vq5b/x92H6UeyiHMzCPx1+Ihfd/b6gf3fsVvj/0Cn7OPYOZnqfws/aGW+vIdM8dJBbNIQkepRDbHn/pquflH+0OB3AGTWc6XWI1LufRgIIBByD3FYlhQAUAFABQAUAFABQBBfXltYWkt1fXENtaxLukmmcIiD1JPAFAHzF8Z/jPL4o3eFvAQuJba5IhmuokbzLrPHlRLjdtPQnq3TGPvdEKdtZEOV9EUvBn7Plw1oNR8e6iNJtQu82sBDzBc4JduVQDIP8AFgHnFEqvSIKPc9Ss/DvgjwlZ3smkeE7a4msYbyVprxRLIJ7cKRHl9xBdSXXbj5RnFZ3k92OyR11xruqfZ9a/s61jkNpJNDb+VCzbz9lSeJuDyCW2n1OAOalJdR3HXGv6lazu95aKlhFfmOaR4WGLYaf57OvOP9cNmenUdeaLIDlL7w74P8UC3h8QeFLFL66e3gklsl8qUXbwGeRGK7WwkYVsknOcYyOavJbMVkzyrxZ8AkurZdQ+HerJqUUkCXS2F04SbypM7GVuAQ2GxuC/dPJNaKr0kJx7D/g/8YL3wRN/wivj6G7jsbciOKWWNvOsvRGXG4pjp3A6ZGACdPm1iClbRn1Hpt/Z6pYxXum3UF3aSjMc0Dh0YZwcEcHkEfhXO1Yss0AFABQAUAFAHF/FT4g6d8PdAF5ejz72fKWlopw0zDqSeyjIyfcdyKqEXJibsfIms+JPGPxa8TWunzTSXU08mLexgykEXXJC9gBnLNk46mulKMFczu2fR3gXwVovwx0mRLWS3ufE8qrBdalIu9bN5QfKLJkMsJcBcjlj1IAO3CUnP0LSsW/E+raXotn/AGt44u/sVtN5yx2E3725kSRClzaAYy0W9Y3Vwcfd6KBkSb0QPzOLtPHfjPxdk/DbwYEtAwkGraoFLyOEEPmBmKpv2jacbzjNVyxj8TFdvY0pfAfxi1Rlk1Lx7a2pI+7ZlkA9sJGgpc0Fsh2YReAPjBpsm/TviBbXBHa8Z3B/BkcUc0HugszN1Lxn488LW8yfEjwct7pcqukupaYQjorARs5dCVDbSAM7D701GL+Fiu1udn4Y1/TvFMDap4Fv1upkYzy6bI/kSxy+WkUEbrkYto1Z2YLuBYErk5BlprRjTvsQeLfCmg/E/TYbTUG8vW/Kb+ztWji/eXMUYUGZlAAETSM20E4I+ZD81Ck4A1c+cIdQ8ZfBzxdcWMc8lncxsGkhJ3290nO18HhlIzg8Ecjgggb2jNEao+rvhB8SrH4iaNLLHF9k1S1wt1alsgZ6Oh7qcH3BBB7E884crNE7nf1AwoAKACgD4k/aR199c+KmpRLIXtdNC2UQ7AqMv+O8tz7CuqkrRM5bntnwo8HD4Z+Bv7Vvkig8RakoM1zcRM8Vmh+ZY5SuDGnHzP0DEZyFFZTlzuxSVkSeOfFkXgLT7SZrWa88UXoeLStLkczSQK7bWV5EY+bAW2lFI3HgcYOwjHm9AbsN8AfCCW+1A+KPijL/AGxrtxhxZzYeGDPZl+6xHTaPkHYHgglU6RBR7ntiKqKFQBVUYAAwAKyKFoAKAAgEEEAg8EGgDxn4ifB0Nef8JL8OJf7E8S25MqxQHZFcHuAOiMRkf3T0Yclq1jU6S2JceqKngbxZH49sb2C+tIbbxZYkDUtMuGMK3ZjIVGdjlhDGS7NEB948/eIYlHl9ATuW/ib4St/iV4LQRsz+JbOJ5tPuJY1ga/RQvmbIidwiLMFUt0O05IbcxGXIwauj5++AutT+HfizowO9Fu5v7PnjPBIkO0A/R9h/4DW1RXiTHRn3PXIaBQAUAIzBVLMQFAySe1AHxz8GNG/4WH8arvWr2IfYoLmXVpkOcbzITGn/AH0QcHqFNdM3yxsZrVnv2pX8cF9qHiLWEls4dLgM03mxG2u4ox8wt9wzDdxudwA3YUtwSxyMUuiLOR+BegXXi3Xr34meKk3XVzIyaXCT8kEYypZR6AfKv0YnJINVN8q5UJa6nqHj7wzdeJNL8vTdc1TRr+FH8iWyuWiRnIGPMA+8uQPcZOOtRGVhtXPkGfxj408OeLv7N8Wa94kCWdwqXtvFqDrIyZBO1s45XkHuCOec108sWrpGd2fbGiarZa5pFpqel3CXFldRiSKRe4P8iOhB5BBBrlatozUu0gPjz4yfELWrn4oajZ+Dtd1qK2SRLUQwXbhHnXCN5ajGBuGMc5IJB5rphFcuqM27vQ+j/hh4W1Xw5o+7xD4g1PWNUuY42nW6nMkUDAElYwc/3sE552g4HSsJSTeiLSscJ8fPDN1o17Z/Ejwqoi1jS3U3qovE8P3dzY64Hyn1U9Rtq6bv7rFJdTpdE1KHULXTvFPh5JmttWj+1TxxIu4spIcXN1KSFijJKiNAGGDtBUECWraMfmeBftDaGnhr4jWXiXRWQ6fq+3UYJYSChmUguVIJznKvn/ppxW1N3VmRLRn2DY3cF/ZW95aSCW2uI1likXoyMMgj6giuY0JqACgDy39o3xanhj4c3dtEw+36uGsoV64Rh+8br2UkZ7FlrSnG8iZOyOI/Z00gaf8ACPWtTZB5uq3JiybB75WhQbdrQp8zgkyggetVUd5WCOw34yyM/hPwz4Q0gi2k8S6kq7V85YhGrKqjypfmhBdkbYBgbTyeckN3LsJ9j6A0fTrbSNKs9OsYxHa2kKwRJ6KoAH8qxbvqWW6API/j/wDC9fG2jf2npKKviGxjPlgD/j6jHJiJ/vdSp9cjvkaU58rsyZK54r+z38TX8Ga1/YWuSbNCvJcFpOPsc3Td7KejA9ODxg51qQ5ldExdj3/47+OV8F+A55rOZV1W/wA21ltYblJHzSjnOFXnIz8xTPWsaceZlydkeH/sseCDrXiaXxNfxbrHS22wbhxJckZB99gOfYshrWrKysRFdT63rnNCG9tYb2zntLuNZbeeNopI26MrDBB+oNAHz18HrOS0Xxj4FvVgmk0LUReWTXlobs7SSu5Ytw5wFZT0Bkzitp62l3IXY0f2g9JuNV+Dv2+/ttQivNIvVkD34t/OeN22HiAlAuXUAcH5Bn1Kpu0hy2Nv9mPxePEPgBNLuZC2oaMRbtuOS0JyYj04AAKY5+5nvSqxs7hF6Hr9ZlBQB8b/ALVWtzaj8TW01iRBpdvHEi543OokZvqQyj/gIrppK0bmctz2DwBbRWPwP8JQuIC7B50Mt7PZ4Z2kbIlhUsDhyPpWcviZS2MrVyL39oz4e2c+2SG30jzwvnvcKJDHO2RI/wAz8qhDEAnAJpr4GHU99rEoKACgD5p/aa+Fv+u8Y+HrYnq2qQR/+jwP/QsezY+8a3pT+yyJLqeETalrni+40HR57qW8kgVNPsInbhQz/Kv5kDPoqjoBWtktSdz7t8AeGLbwd4S07RLTDC3j/eSAY82Q8u/4kn6DA7VySfM7miVjoKQwoA8G+yfZ/wBqHXYn2tFq+iEMrIXBXy0UggEEjMXQHNbf8uyeps6/Yx/8Kk8bW6RWkcX2N5xHbaBPpS7gpO4iUnzD8g5HTAz1FSn7yDoeE/sz65JpHxVsLcOVttSjktJR2Pylk49dyqPxNbVVeJMdz7WrlNAoA+NP2p9Gm0/4ozX7jMGp28UyMOmUURlfqNgP/AhXTSd42M5bntXw51EyfBDwtdpefZFjjeEs96lohKO64Z2Vj/B2GaykvfZS2MLU5Qv7R3w+1CSWFobzRygmjuPPjeTy5xhZMDeMsuGwM5zgZql8DDqe/ViUFABQB49+0x43/wCEZ8FHSbKTbqmsBoVweY4P+WjdO4IUdPvEj7taUo3dyZOx8kHQ9Vh0CLX/ALJMulPcG2S6H3fNADY9Rx0PTg46Gum6vYix9ifs8+PpfG3hB4dScvrGllYbhzkmVCD5chOOp2sDyeVJ4yBXNUjysuLueqVmUFAHhAuftf7UmsOVfy9K0U7yis5xsRuFX5j/AK3oOfStfsE9Ta8RTW8Hwq8cT25j8lrB4g32+5nbcVYYaOYAxH5hwM5zz0FJfEg6HgX7Neiyav8AFfTZQhMGnpJdyn0wpVf/AB9l/WtqrtEmO59tVymgUAeUftJ+El8S/Dq4vYUBv9H3XkTcZMYH71c+m0bvcoK0pysyZLQ5P9nDUv7U+FGoaaizPe6TeGSEW0cTzIrjcrRiX5AxPmjJ4qqqtK4R2IfjaLm20jw14qhaS71Lwxqa/aY5riKSZVdldftHlAKh3KFwuRhh1zRDqu4n3PoDTL631PTbW/spBLa3MSzROP4kYZB/I1i9CyzQBFeXMNnaT3V1KsVvAjSSSOcBFUZJPsAKAPh7xFf6j8Yvi2qWQZftswtrVW6QW65O4/RdzkepOO1dSShEz3Z9SeN9A0PQPglrGiyKkWk2emuieYcZkAyje7mTafdj71hFtyuW9jwP9keWVfiTfRozeW+mSF1zwcSR4P8An1rat8JEdz6+rmNCO5nitbaW4uJFjgiQySOxwFUDJJ9sUAfO/wAJrv8AtP8A4Tzx3qLrGmr3n2O0e5uJLXy4xlyHnjUmJQvlrvHAKYz0raelokLuafx71R9L+C32aa5kkn1m6jRI3uxciONcOfLlwC8f7tTubLfPz1wFTV5Dlsan7L3hAaB4E/ti6jK3+skTfMMFYFyIx+OS+e4YelFWV3YIrQ9lrIoKAGyIksbRyKrowKsrDIIPUEUAfHfwR1UeBvjBf+HNVdXsr2aXSLgHJQyByqNjvlht56BzXTNc0bozWjPfNS0iA2914Z1hEXRb9fsKhI47S3iZwWQWcCh2kkB2szOcKVLKeGUYp9UUct8BfEd34e1W9+GnipvL1PTnc2EhPyzxfeKqTyeDvX/ZJHG3FVUV/eQRdtD3Osijkfit4b1Hxb4F1HRtIvlsrq4A+ZwdsgByUJHIBxgkfkQTVQfK7sTV0fGv2Hxv8MdbN2LbUdFvEBj88JmORTjI3co68A45GQO4rpvGaM9UP1TxL46+JU9vp11c6hrLK2UtoIQFDf3iqKBwM/Megzz1oSjALtn058APhg/gPSJ77V9ja9fqolVcMLaMciMMOpJ5Yg4JCgZ25OFSfM9C4qx6zWZR4p+0D4rurxrT4e+FiJ9d1khLgI3+phPOGI6bhkn0QEkYYGtacftMmT6G9pGjRaJDo3hTQ7m6jbS4BG8ltM1vcIzsDJcCKYGK4iYnJ+9sO4LuY4WW76sPI8L/AGk/EI8TfESz8OaUVe00rFmiR4Km4cjeBj0wiY7FTW1JWV2TJ3Z9c6dZQadp9rY2aeXbW0SwxJ/dRQAB+QFc25oWKACgAoA+If2jNCbQ/itqrqjJb6htvYif4t4+c/8AfYeuqm7xM5bnuvws8Yx/EbwgGlkZfFOmw+TffZlSO7u4MZxDISvl+YwQMwIwQcbCVcZTjyvyKTuR+PPCUHjvT7cwXFvp3i/TJvI0++tnZInlTe5tUkJ3yNGEOZABhgSADvQEZcvoDVyx8Nvi/wCbeDwx8RIv7G8T25ETSzgRxXJ7H0ViOf7rdVPIWiVPrHYE+jPZayKCgA6UAFAHkPxN+MFvpVx/wj/glBrfim4bykSAeZHA3fOPvMP7o6YO4jGDpGnfV7EuXYyfA3hOfwQl/q+v3r3XjO/jFxf3aATNp0LscNsI/eLuXEhU8DpgDcalLm0WwJWNHx94mi+Fvgp5mEUeuXe6LTtORxLBbMCQ0sW5dyR4Kt5eSoO1QAMmpjHnYN2R88/A7SbnxL8XNFaRpJmguf7QuJXJY/uzv3Mepy20Z9WrebtElas+6a5DQKACgAoA4L4v/Dey+ImhJBJKLXU7Ul7S627tpPVGHdTge4IB9QbhPlYmrnyZNYeMPg/4vtr2a2ksruFyIpSN9vdJ3XcOGUjGRkEZHQ4x0XjNGeqPpfwh4t0T4pWButOmey1lYPs9/Y+ZmcW+S0iQEkBRI2wNIADgDO1ghXBxcC07jfE+gab4wjXTfGum+dfebHBHcWuxJoJ5Q0nkQvxvSGE72LZDdQCRtAm46oHrucho/hv4g+Fo4n+G/iy18QaN5UdzFpt+Qr+S+4R4V/uoQpwVZA204FU5RfxIVmtjWg+KPxK03dHrnwyu7yUHhtP8wL+iyZ/OlyRezHd9gn+KfxH1BRHovwwvbScn79/5pT9Uj/nRyRW7C77GfqPhr4n+M3WHxv4jtPDemXTmMadYkNJIdjExgIfmBVXOGkbp0PZ80I7K4rN7nQ+CPD+ieGLcW/gu1lR7qKESaoyedeNBcrmC5XjAQSqyNHtHC7zgD5pk29xpW2LfinxDo3w30uHVfEfktqzFriz0u2Y5S4dSJxG+eIHbDkMOGyeTtVRJy0QPQ+ZZY/F/xg8ZT3cdvLf3spAOwbYLWPJ2rk8Ig56nJOTySSd/dgiNWfVvwY+GVr8O9Gk8yRbrWrsKbu5XO0Y6Rx5/hGep5Y8nHAHPOfMzRKx6LUDCgAoAKACgCrqum2WrWEtjqlpBd2cow8M6B1buMg+/NCdtgPl74ufCC+8DTnxX8P57yOytiZJYopG86yHOXVhy0eCQe4HXIyR0Qqc2kiHG2qJPB/7Qa3Nqun/EDTjcgo0Q1KxASZAy7SSoxg4J+ZCp9BRKl1iCl3PWdD1fwn4huoLvwp4isJbpLgXUdnLJ5TEJatBHEUIDiNS2/ocMSR1rJprdD0N2x0PVrG40dIbmRrW2e3glH2liGgitpQWIPUmV1zxyFUnpSvuMr6Lo/iOFbB726keSGy0tXWS6Zg00bSC6J65JR1Of4iBnpmm2g1MW/m8MeE7WMeJPFFnaTW9vawrFDLulC2szvCypyxJV9r/KcjIzT1lshaI8x8X/AB/srC1ew+HmleScylb+9XJj8xy7+XGSeNxBG44GANmAMXGl/MJy7GZ8J/hXqfxJ1B/Ffjm6u20+aTeN7ES3pHof4YxjGR24XGMhzmo6RBK+rPqXQ9H07QdNisNGsoLKziGFihQKOnU+pOOSeT3rBtvVll+kAUAFABQAUAFABQAHnrQB84/Fj9nxr29n1XwJ5EJlYvLpkjbEBPXyT0UE/wAJwBzggYWt4VekiHHsePn4PePhcmD/AIRq73g4zvj2/wDfW7b+tae0j3Fys63w/wDBv4qWce2ymfSFPVV1PZ/6LY1LqQDlY7xB8HfiteQ7L25fV067G1Tf/wCjCBQqkA5Wcg3we8fLcCA+GrveTjIeMr/31ux+tV7SPcOVnq/wr/Z5mjvItS8emLy4zuTTIn37z28xwcYH91c57nqDnOr0iNR7n0rDFHDEkUKLHEihURBgKBwAB2FYFjqACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgD//Z",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Update company data

Company data is used to display your information and logo in the YourOwn Wallet app when customers are submitting packages.

Authorizations:
BasicAuth
Request Body schema: application/json
required
name
required
string

A name to display in the app for your company

description
string
logo
required
string (Logo)

A base64 encoded version of your logo preferably 128x128px

object (CompanySettings)

Responses

Request samples

Content type
application/json
{
  • "name": "Michigan Rentals",
  • "description": "Apply for your next rental with Michigan's most trusted property manager",
  • "logo": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSgBBwcHCggKEwoKEygaFhooKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKP/AABEIAIAAgAMBEQACEQEDEQH/xAGiAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgsQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+gEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoLEQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/APqmgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKAPn34rftBQaRdTaV4Kjt765QlZb+T5oUPQiMD75/2s7eOjZraFK+rIcux5Efjr8RN+7+31xn7v2K3x/6BmtPZx7C5mbelftE+OYF8uSLS9Qc95rVg3/kNlH6UnSiHMx2qftFeOZk8tLfSbB/70Vq5b/x92H6UeyiHMzCPx1+Ihfd/b6gf3fsVvj/0Cn7OPYOZnqfws/aGW+vIdM8dJBbNIQkepRDbHn/pquflH+0OB3AGTWc6XWI1LufRgIIBByD3FYlhQAUAFABQAUAFABQBBfXltYWkt1fXENtaxLukmmcIiD1JPAFAHzF8Z/jPL4o3eFvAQuJba5IhmuokbzLrPHlRLjdtPQnq3TGPvdEKdtZEOV9EUvBn7Plw1oNR8e6iNJtQu82sBDzBc4JduVQDIP8AFgHnFEqvSIKPc9Ss/DvgjwlZ3smkeE7a4msYbyVprxRLIJ7cKRHl9xBdSXXbj5RnFZ3k92OyR11xruqfZ9a/s61jkNpJNDb+VCzbz9lSeJuDyCW2n1OAOalJdR3HXGv6lazu95aKlhFfmOaR4WGLYaf57OvOP9cNmenUdeaLIDlL7w74P8UC3h8QeFLFL66e3gklsl8qUXbwGeRGK7WwkYVsknOcYyOavJbMVkzyrxZ8AkurZdQ+HerJqUUkCXS2F04SbypM7GVuAQ2GxuC/dPJNaKr0kJx7D/g/8YL3wRN/wivj6G7jsbciOKWWNvOsvRGXG4pjp3A6ZGACdPm1iClbRn1Hpt/Z6pYxXum3UF3aSjMc0Dh0YZwcEcHkEfhXO1Yss0AFABQAUAFAHF/FT4g6d8PdAF5ejz72fKWlopw0zDqSeyjIyfcdyKqEXJibsfIms+JPGPxa8TWunzTSXU08mLexgykEXXJC9gBnLNk46mulKMFczu2fR3gXwVovwx0mRLWS3ufE8qrBdalIu9bN5QfKLJkMsJcBcjlj1IAO3CUnP0LSsW/E+raXotn/AGt44u/sVtN5yx2E3725kSRClzaAYy0W9Y3Vwcfd6KBkSb0QPzOLtPHfjPxdk/DbwYEtAwkGraoFLyOEEPmBmKpv2jacbzjNVyxj8TFdvY0pfAfxi1Rlk1Lx7a2pI+7ZlkA9sJGgpc0Fsh2YReAPjBpsm/TviBbXBHa8Z3B/BkcUc0HugszN1Lxn488LW8yfEjwct7pcqukupaYQjorARs5dCVDbSAM7D701GL+Fiu1udn4Y1/TvFMDap4Fv1upkYzy6bI/kSxy+WkUEbrkYto1Z2YLuBYErk5BlprRjTvsQeLfCmg/E/TYbTUG8vW/Kb+ztWji/eXMUYUGZlAAETSM20E4I+ZD81Ck4A1c+cIdQ8ZfBzxdcWMc8lncxsGkhJ3290nO18HhlIzg8Ecjgggb2jNEao+rvhB8SrH4iaNLLHF9k1S1wt1alsgZ6Oh7qcH3BBB7E884crNE7nf1AwoAKACgD4k/aR199c+KmpRLIXtdNC2UQ7AqMv+O8tz7CuqkrRM5bntnwo8HD4Z+Bv7Vvkig8RakoM1zcRM8Vmh+ZY5SuDGnHzP0DEZyFFZTlzuxSVkSeOfFkXgLT7SZrWa88UXoeLStLkczSQK7bWV5EY+bAW2lFI3HgcYOwjHm9AbsN8AfCCW+1A+KPijL/AGxrtxhxZzYeGDPZl+6xHTaPkHYHgglU6RBR7ntiKqKFQBVUYAAwAKyKFoAKAAgEEEAg8EGgDxn4ifB0Nef8JL8OJf7E8S25MqxQHZFcHuAOiMRkf3T0Yclq1jU6S2JceqKngbxZH49sb2C+tIbbxZYkDUtMuGMK3ZjIVGdjlhDGS7NEB948/eIYlHl9ATuW/ib4St/iV4LQRsz+JbOJ5tPuJY1ga/RQvmbIidwiLMFUt0O05IbcxGXIwauj5++AutT+HfizowO9Fu5v7PnjPBIkO0A/R9h/4DW1RXiTHRn3PXIaBQAUAIzBVLMQFAySe1AHxz8GNG/4WH8arvWr2IfYoLmXVpkOcbzITGn/AH0QcHqFNdM3yxsZrVnv2pX8cF9qHiLWEls4dLgM03mxG2u4ox8wt9wzDdxudwA3YUtwSxyMUuiLOR+BegXXi3Xr34meKk3XVzIyaXCT8kEYypZR6AfKv0YnJINVN8q5UJa6nqHj7wzdeJNL8vTdc1TRr+FH8iWyuWiRnIGPMA+8uQPcZOOtRGVhtXPkGfxj408OeLv7N8Wa94kCWdwqXtvFqDrIyZBO1s45XkHuCOec108sWrpGd2fbGiarZa5pFpqel3CXFldRiSKRe4P8iOhB5BBBrlatozUu0gPjz4yfELWrn4oajZ+Dtd1qK2SRLUQwXbhHnXCN5ajGBuGMc5IJB5rphFcuqM27vQ+j/hh4W1Xw5o+7xD4g1PWNUuY42nW6nMkUDAElYwc/3sE552g4HSsJSTeiLSscJ8fPDN1o17Z/Ejwqoi1jS3U3qovE8P3dzY64Hyn1U9Rtq6bv7rFJdTpdE1KHULXTvFPh5JmttWj+1TxxIu4spIcXN1KSFijJKiNAGGDtBUECWraMfmeBftDaGnhr4jWXiXRWQ6fq+3UYJYSChmUguVIJznKvn/ppxW1N3VmRLRn2DY3cF/ZW95aSCW2uI1likXoyMMgj6giuY0JqACgDy39o3xanhj4c3dtEw+36uGsoV64Rh+8br2UkZ7FlrSnG8iZOyOI/Z00gaf8ACPWtTZB5uq3JiybB75WhQbdrQp8zgkyggetVUd5WCOw34yyM/hPwz4Q0gi2k8S6kq7V85YhGrKqjypfmhBdkbYBgbTyeckN3LsJ9j6A0fTrbSNKs9OsYxHa2kKwRJ6KoAH8qxbvqWW6API/j/wDC9fG2jf2npKKviGxjPlgD/j6jHJiJ/vdSp9cjvkaU58rsyZK54r+z38TX8Ga1/YWuSbNCvJcFpOPsc3Td7KejA9ODxg51qQ5ldExdj3/47+OV8F+A55rOZV1W/wA21ltYblJHzSjnOFXnIz8xTPWsaceZlydkeH/sseCDrXiaXxNfxbrHS22wbhxJckZB99gOfYshrWrKysRFdT63rnNCG9tYb2zntLuNZbeeNopI26MrDBB+oNAHz18HrOS0Xxj4FvVgmk0LUReWTXlobs7SSu5Ytw5wFZT0Bkzitp62l3IXY0f2g9JuNV+Dv2+/ttQivNIvVkD34t/OeN22HiAlAuXUAcH5Bn1Kpu0hy2Nv9mPxePEPgBNLuZC2oaMRbtuOS0JyYj04AAKY5+5nvSqxs7hF6Hr9ZlBQB8b/ALVWtzaj8TW01iRBpdvHEi543OokZvqQyj/gIrppK0bmctz2DwBbRWPwP8JQuIC7B50Mt7PZ4Z2kbIlhUsDhyPpWcviZS2MrVyL39oz4e2c+2SG30jzwvnvcKJDHO2RI/wAz8qhDEAnAJpr4GHU99rEoKACgD5p/aa+Fv+u8Y+HrYnq2qQR/+jwP/QsezY+8a3pT+yyJLqeETalrni+40HR57qW8kgVNPsInbhQz/Kv5kDPoqjoBWtktSdz7t8AeGLbwd4S07RLTDC3j/eSAY82Q8u/4kn6DA7VySfM7miVjoKQwoA8G+yfZ/wBqHXYn2tFq+iEMrIXBXy0UggEEjMXQHNbf8uyeps6/Yx/8Kk8bW6RWkcX2N5xHbaBPpS7gpO4iUnzD8g5HTAz1FSn7yDoeE/sz65JpHxVsLcOVttSjktJR2Pylk49dyqPxNbVVeJMdz7WrlNAoA+NP2p9Gm0/4ozX7jMGp28UyMOmUURlfqNgP/AhXTSd42M5bntXw51EyfBDwtdpefZFjjeEs96lohKO64Z2Vj/B2GaykvfZS2MLU5Qv7R3w+1CSWFobzRygmjuPPjeTy5xhZMDeMsuGwM5zgZql8DDqe/ViUFABQB49+0x43/wCEZ8FHSbKTbqmsBoVweY4P+WjdO4IUdPvEj7taUo3dyZOx8kHQ9Vh0CLX/ALJMulPcG2S6H3fNADY9Rx0PTg46Gum6vYix9ifs8+PpfG3hB4dScvrGllYbhzkmVCD5chOOp2sDyeVJ4yBXNUjysuLueqVmUFAHhAuftf7UmsOVfy9K0U7yis5xsRuFX5j/AK3oOfStfsE9Ta8RTW8Hwq8cT25j8lrB4g32+5nbcVYYaOYAxH5hwM5zz0FJfEg6HgX7Neiyav8AFfTZQhMGnpJdyn0wpVf/AB9l/WtqrtEmO59tVymgUAeUftJ+El8S/Dq4vYUBv9H3XkTcZMYH71c+m0bvcoK0pysyZLQ5P9nDUv7U+FGoaaizPe6TeGSEW0cTzIrjcrRiX5AxPmjJ4qqqtK4R2IfjaLm20jw14qhaS71Lwxqa/aY5riKSZVdldftHlAKh3KFwuRhh1zRDqu4n3PoDTL631PTbW/spBLa3MSzROP4kYZB/I1i9CyzQBFeXMNnaT3V1KsVvAjSSSOcBFUZJPsAKAPh7xFf6j8Yvi2qWQZftswtrVW6QW65O4/RdzkepOO1dSShEz3Z9SeN9A0PQPglrGiyKkWk2emuieYcZkAyje7mTafdj71hFtyuW9jwP9keWVfiTfRozeW+mSF1zwcSR4P8An1rat8JEdz6+rmNCO5nitbaW4uJFjgiQySOxwFUDJJ9sUAfO/wAJrv8AtP8A4Tzx3qLrGmr3n2O0e5uJLXy4xlyHnjUmJQvlrvHAKYz0raelokLuafx71R9L+C32aa5kkn1m6jRI3uxciONcOfLlwC8f7tTubLfPz1wFTV5Dlsan7L3hAaB4E/ti6jK3+skTfMMFYFyIx+OS+e4YelFWV3YIrQ9lrIoKAGyIksbRyKrowKsrDIIPUEUAfHfwR1UeBvjBf+HNVdXsr2aXSLgHJQyByqNjvlht56BzXTNc0bozWjPfNS0iA2914Z1hEXRb9fsKhI47S3iZwWQWcCh2kkB2szOcKVLKeGUYp9UUct8BfEd34e1W9+GnipvL1PTnc2EhPyzxfeKqTyeDvX/ZJHG3FVUV/eQRdtD3Osijkfit4b1Hxb4F1HRtIvlsrq4A+ZwdsgByUJHIBxgkfkQTVQfK7sTV0fGv2Hxv8MdbN2LbUdFvEBj88JmORTjI3co68A45GQO4rpvGaM9UP1TxL46+JU9vp11c6hrLK2UtoIQFDf3iqKBwM/Megzz1oSjALtn058APhg/gPSJ77V9ja9fqolVcMLaMciMMOpJ5Yg4JCgZ25OFSfM9C4qx6zWZR4p+0D4rurxrT4e+FiJ9d1khLgI3+phPOGI6bhkn0QEkYYGtacftMmT6G9pGjRaJDo3hTQ7m6jbS4BG8ltM1vcIzsDJcCKYGK4iYnJ+9sO4LuY4WW76sPI8L/AGk/EI8TfESz8OaUVe00rFmiR4Km4cjeBj0wiY7FTW1JWV2TJ3Z9c6dZQadp9rY2aeXbW0SwxJ/dRQAB+QFc25oWKACgAoA+If2jNCbQ/itqrqjJb6htvYif4t4+c/8AfYeuqm7xM5bnuvws8Yx/EbwgGlkZfFOmw+TffZlSO7u4MZxDISvl+YwQMwIwQcbCVcZTjyvyKTuR+PPCUHjvT7cwXFvp3i/TJvI0++tnZInlTe5tUkJ3yNGEOZABhgSADvQEZcvoDVyx8Nvi/wCbeDwx8RIv7G8T25ETSzgRxXJ7H0ViOf7rdVPIWiVPrHYE+jPZayKCgA6UAFAHkPxN+MFvpVx/wj/glBrfim4bykSAeZHA3fOPvMP7o6YO4jGDpGnfV7EuXYyfA3hOfwQl/q+v3r3XjO/jFxf3aATNp0LscNsI/eLuXEhU8DpgDcalLm0WwJWNHx94mi+Fvgp5mEUeuXe6LTtORxLBbMCQ0sW5dyR4Kt5eSoO1QAMmpjHnYN2R88/A7SbnxL8XNFaRpJmguf7QuJXJY/uzv3Mepy20Z9WrebtElas+6a5DQKACgAoA4L4v/Dey+ImhJBJKLXU7Ul7S627tpPVGHdTge4IB9QbhPlYmrnyZNYeMPg/4vtr2a2ksruFyIpSN9vdJ3XcOGUjGRkEZHQ4x0XjNGeqPpfwh4t0T4pWButOmey1lYPs9/Y+ZmcW+S0iQEkBRI2wNIADgDO1ghXBxcC07jfE+gab4wjXTfGum+dfebHBHcWuxJoJ5Q0nkQvxvSGE72LZDdQCRtAm46oHrucho/hv4g+Fo4n+G/iy18QaN5UdzFpt+Qr+S+4R4V/uoQpwVZA204FU5RfxIVmtjWg+KPxK03dHrnwyu7yUHhtP8wL+iyZ/OlyRezHd9gn+KfxH1BRHovwwvbScn79/5pT9Uj/nRyRW7C77GfqPhr4n+M3WHxv4jtPDemXTmMadYkNJIdjExgIfmBVXOGkbp0PZ80I7K4rN7nQ+CPD+ieGLcW/gu1lR7qKESaoyedeNBcrmC5XjAQSqyNHtHC7zgD5pk29xpW2LfinxDo3w30uHVfEfktqzFriz0u2Y5S4dSJxG+eIHbDkMOGyeTtVRJy0QPQ+ZZY/F/xg8ZT3cdvLf3spAOwbYLWPJ2rk8Ig56nJOTySSd/dgiNWfVvwY+GVr8O9Gk8yRbrWrsKbu5XO0Y6Rx5/hGep5Y8nHAHPOfMzRKx6LUDCgAoAKACgCrqum2WrWEtjqlpBd2cow8M6B1buMg+/NCdtgPl74ufCC+8DTnxX8P57yOytiZJYopG86yHOXVhy0eCQe4HXIyR0Qqc2kiHG2qJPB/7Qa3Nqun/EDTjcgo0Q1KxASZAy7SSoxg4J+ZCp9BRKl1iCl3PWdD1fwn4huoLvwp4isJbpLgXUdnLJ5TEJatBHEUIDiNS2/ocMSR1rJprdD0N2x0PVrG40dIbmRrW2e3glH2liGgitpQWIPUmV1zxyFUnpSvuMr6Lo/iOFbB726keSGy0tXWS6Zg00bSC6J65JR1Of4iBnpmm2g1MW/m8MeE7WMeJPFFnaTW9vawrFDLulC2szvCypyxJV9r/KcjIzT1lshaI8x8X/AB/srC1ew+HmleScylb+9XJj8xy7+XGSeNxBG44GANmAMXGl/MJy7GZ8J/hXqfxJ1B/Ffjm6u20+aTeN7ES3pHof4YxjGR24XGMhzmo6RBK+rPqXQ9H07QdNisNGsoLKziGFihQKOnU+pOOSeT3rBtvVll+kAUAFABQAUAFABQAHnrQB84/Fj9nxr29n1XwJ5EJlYvLpkjbEBPXyT0UE/wAJwBzggYWt4VekiHHsePn4PePhcmD/AIRq73g4zvj2/wDfW7b+tae0j3Fys63w/wDBv4qWce2ymfSFPVV1PZ/6LY1LqQDlY7xB8HfiteQ7L25fV067G1Tf/wCjCBQqkA5Wcg3we8fLcCA+GrveTjIeMr/31ux+tV7SPcOVnq/wr/Z5mjvItS8emLy4zuTTIn37z28xwcYH91c57nqDnOr0iNR7n0rDFHDEkUKLHEihURBgKBwAB2FYFjqACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgD//Z",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Get company data

Company data is used to display your information and logo in the YourOwn Wallet app when customers are submitting packages.

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Template

Templates are used to define the specific data requirements for a product or service (e.g., loan applications). Each financial product or consumer data sharing request should have a dedicated template.

The YourOwn Wallet consumer application uses your template definition to ensure that data is complete to your specifications, accurate, and trustworthy.

In addition to defining what each completed application requires, you must also specify the daysRequested, webhook and pubkey. Use the webhook parameter to specify how you will be notified when a new package is available for you to retrieve. See Webhooks for more information on the webhook contents. Pubkey is used to asymmetrically encrypt the package data. This ensures that package data is secure, and only readable by clients with the matching private key. Package data is encrypted locally on the consumer device and is never seen by YourOwn. YourOwn does not have access to the private key and you must take steps to ensure that the matching private key is maintained in a secure way.

daysRequested is defined at the template level and applies to all requirements. If any requirement specifies documentType: income, then daysRequested must be either 365 or 730.

Example: 90 Days of financial data

Suppose you wanted to offer an easy loan application that required 90 days of bank statements and a photo ID. You would make the following call, substituting your own webhook, redirectUri, and pubkey.

{
  "name": "Auto loan application",
  "description": "May 2025 Auto loan requirements",
  "status": "draft",
  "webhook": "https://example.com/new-package-webhook",
  "redirectUri": "https://example.com/congratulations",
  "pubkey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7SSKBwMEbXHmimvlHwrKrKQIQGGc7ATrGDQdUn8Qk+qsXr7rClBOmd2WrKIqI7CI9L/aQ+fDZ0QGvQvx8+w5N1YjXRxWw+vPiGlTkjCYVQIDAQAB",
  "daysRequested": 90,
  "requirements": [
    {
      "description": "Bank account statements",
      "documentType": "depository"
    },
    {
      "description": "Identity documents",
      "permitted": [ "passport", "stateId" ]
    }
  ]
}

On successful template creation the response will contain the template details including the templateUri. Use the templateUri on your website to enable consumers to easily submit their financial data.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Auto loan application",
  "description": "May 2025 Auto loan requirements",
  "status": "draft",
  "webhook": "https://example.com/package-webhook",
  "redirectUri": "https://example.com/congratulations",
  "templateUri": "https://app.yourownwallet.com/direct-share/123e4567-e89b-12d3-a456-426614174000",
  "pubkey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7SSKBwMEbXHmimvlHwrKrKQIQGGc7ATrGDQdUn8Qk+qsXr7rClBOmd2WrKIqI7CI9L/aQ+fDZ0QGvQvx8+w5N1YjXRxWw+vPiGlTkjCYVQIDAQAB",
  "daysRequested": 90,
  "requirements": [
    {
      "description": "Bank account statements",
      "documentType": "depository"
    },
    {
      "description": "Identity documents",
      "permitted": [ "passport", "stateId" ]
    }
  ],
  "createdAt": "2023-01-15T14:30:00Z",
  "updatedAt": "2023-02-10T09:15:00Z"
}

For this template you would add the following link on your own website to enable consumers to easily submit their financial data.

<a href="https://app.yourownwallet.com/direct-share/123e4567-e89b-12d3-a456-426614174000" target="_blank">Apply</a>

Create a new template

Templates are how you define your package requirements. You can define what documents are required, the amount of history needed and the webhook to notify when a new package is available for retrieval.

Authorizations:
BasicAuth
Request Body schema: application/json
required
One of
name
required
string

Friendly package name (e.g. 'VA Loan', 'Auto Loan')

description
string
status
string (TemplateStatus)
Enum: "draft" "published" "archived"

The current template status

webhook
required
string

The webhook to be called when a package is submitted for this template

redirectUri
required
string

Where you want the user to land after they complete their package upload

pubkey
required
string

RSA public key in Base64 encoded DER format used for hybrid encryption of package data. Accepted key sizes: 2048, 3072, or 4096 bits. You will need the matching RSA private key to decrypt package data.

daysRequested
required
number [ 1 .. 365 ]
Enum: 365 730

Time period for financial documents in days

required
Array of objects or objects

The list of required documents for a user to submit this package.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "VA Loan application",
  • "description": "Requirements for a VA loan application",
  • "status": "draft",
  • "webhook": "https://example.com/package-webhook",
  • "redirectUri": "https://example.com/congratulations",
  • "pubkey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7SSKBwMEbXHmimvlHwrKrKQIQGGc7ATrGDQdUn8Qk+qsXr7rClBOmd2WrKIqI7CI9L/aQ+fDZ0QGvQvx8+w5N1YjXRxWw+vPiGlTkjCYVQIDAQAB",
  • "daysRequested": 365,
  • "requirements": null
}

Response samples

Content type
application/json
{}

Modify a template

Update an existing package template. Only templates owned by the authenticated partner can be updated. Templates in 'published' status can be updated but may require careful consideration of existing packages. To archive a template, set the status field to 'archived'.

Authorizations:
BasicAuth
path Parameters
templateId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package template to update

Request Body schema: application/json
required
One of
name
required
string

Friendly package name (e.g. 'VA Loan', 'Auto Loan')

description
string
status
string (TemplateStatus)
Enum: "draft" "published" "archived"

The current template status

webhook
required
string

The webhook to be called when a package is submitted for this template

redirectUri
required
string

Where you want the user to land after they complete their package upload

pubkey
required
string

RSA public key in Base64 encoded DER format used for hybrid encryption of package data. Accepted key sizes: 2048, 3072, or 4096 bits. You will need the matching RSA private key to decrypt package data.

daysRequested
required
number [ 1 .. 365 ]
Enum: 365 730

Time period for financial documents in days

required
Array of objects or objects

The list of required documents for a user to submit this package.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "VA Loan application",
  • "description": "Requirements for a VA loan application",
  • "status": "draft",
  • "webhook": "https://example.com/package-webhook",
  • "redirectUri": "https://example.com/congratulations",
  • "pubkey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7SSKBwMEbXHmimvlHwrKrKQIQGGc7ATrGDQdUn8Qk+qsXr7rClBOmd2WrKIqI7CI9L/aQ+fDZ0QGvQvx8+w5N1YjXRxWw+vPiGlTkjCYVQIDAQAB",
  • "daysRequested": 365,
  • "requirements": null
}

Response samples

Content type
application/json
{}

Get a template

Returns details about a template

Authorizations:
BasicAuth
path Parameters
templateId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package template to retrieve

Responses

Response samples

Content type
application/json
{}

List all templates

Get a list of all template summaries with optional filtering. Objects will be sorted in descending order by date created.

Authorizations:
BasicAuth
query Parameters
status
string (TemplateStatus)
Enum: "draft" "published" "archived"
Example: status=draft

Filter templates by status

name
string

Filter templates where the name contains this string

limit
integer (LimitParameter) [ 1 .. 100 ]
Default: 20

Maximum number of items to return

nextToken
string (NextTokenParameter)

Opaque token for fetching the next page of results

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {}
}

Package

A package is a point-in-time snapshot of a consumers financial identity for a specific template. When a consumer submits a package it will show up in the ready state and a webhook will be sent to the endpoint you specified in the template. Once ready you can retrieve the package and mark the package as read or archived depending on your workflow. User data in packages are immutable and new data will be handled via package updates.

Modify a package

Update the status field of a package.

Authorizations:
BasicAuth
path Parameters
packageId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package to update

Request Body schema: application/json
required
status
required
string (PackageStatus)
Enum: "ready" "retrieved" "archived"

The current package status

Responses

Request samples

Content type
application/json
{
  • "status": "ready"
}

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Get a package

Returns detailed information about a specific package.

Authorizations:
BasicAuth
path Parameters
packageId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package to retrieve

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Create a new `RefreshRequest`.

Creating a new RefreshRequest will trigger a notification to the user to update package data. Once the user responds and submits updated data, you will be notified via the webhook associated with the template for this package. There can only be one outstanding RefreshRequest, and subsequent calls will return the existing RefreshRequest unless it has already been completed by the user. New RefreshRequests will not be created if an existing request has been completed by the user within the past 60 minutes. The user may dismiss the request, and you may cancel the request via a PATCH call.

Authorizations:
BasicAuth
path Parameters
packageId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the package to create a refresh request for

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

List `RefreshRequests` for a package

List all RefreshRequests for a package

Authorizations:
BasicAuth
path Parameters
packageId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the package to list refresh requests for

query Parameters
status
string (RefreshRequestStatus)
Enum: "pending" "completed" "dismissed" "cancelled"
Example: status=pending

Filter refresh requests by status

limit
integer (LimitParameter) [ 1 .. 100 ]
Default: 20

Maximum number of items to return

nextToken
string (NextTokenParameter)

Opaque token for fetching the next page of results

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Get a refresh request

Returns detailed information about a specific refresh request.

Authorizations:
BasicAuth
path Parameters
refreshRequestId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the refresh request to retrieve

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Cancel an outstanding refresh request

Cancel an existing refresh request. Once cancelled, a request cannot be moved to a different status. However, a new request can be made after 60 minutes.

Authorizations:
BasicAuth
path Parameters
refreshRequestId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the refresh request to cancel

Request Body schema: application/json
required
status
required
string
Value: "cancelled"

Responses

Request samples

Content type
application/json
{
  • "status": "cancelled"
}

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

List packages

Get a list of packages with optional filtering. Objects will be sorted in descending order by date created.

Authorizations:
BasicAuth
path Parameters
templateId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package template

query Parameters
status
string (PackageStatus)
Enum: "ready" "retrieved" "archived"
Example: status=ready

Filter packages by status

limit
integer (LimitParameter) [ 1 .. 100 ]
Default: 20

Maximum number of items to return

nextToken
string (NextTokenParameter)

Opaque token for fetching the next page of results

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Update

For most use cases a single package should be enough. However, should an existing package require additional or refreshed data it will be handled via package updates. Package updates can contain all the same types of data that a package can contain and each package update is associated with a specific package.

Modify a package update

Modify the status field of a package update

Authorizations:
BasicAuth
path Parameters
updateId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package update

Request Body schema: application/json
required
status
required
string (UpdateStatus)
Enum: "ready" "retrieved"

The current update status

Responses

Request samples

Content type
application/json
{
  • "status": "ready"
}

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Get a package update

Returns detailed information about a specific package update.

Authorizations:
BasicAuth
path Parameters
updateId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the update to retrieve

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

List updates for a package

Get a list of updates associated with a package. Objects will be sorted in descending order, by date created.

Authorizations:
BasicAuth
path Parameters
packageId
required
string <uuid> (ObjectId)
Example: 123e4567-e89b-12d3-a456-426614174000

Id of the package to retrieve

query Parameters
limit
integer (LimitParameter) [ 1 .. 100 ]
Default: 20

Maximum number of items to return

nextToken
string (NextTokenParameter)

Opaque token for fetching the next page of results

Responses

Response samples

Content type
application/json
{
  • "event": {
    },
  • "data": {
    }
}

Package or update ready Webhook

This webhook is fired when a user submits a package or update

Authorizations:
BasicAuth
Request Body schema: application/json
required
Array
event
required
string
Enum: "package" "update"
templateId
required
string <uuid> (ObjectId)
packageId
required
string <uuid> (ObjectId)
updateId
string <uuid>

The updateId will only be populated if the event is update

createdAt
required
string <date-time> (DateTime)

Request samples

Content type
application/json
[
  • {
    }
]