Unit API

https://www.unit.co/docs/api
Admin
Unit API is a REST-based financial API platform that enables developers to build banking and lending...
Tokens:355,397
Snippets:2,250
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Full Resource Object Example

Source: https://www.unit.co/docs/api/using-the-api

A detailed example of a resource object including attributes and relationship placeholders.

```json
{
  "type": "individualCustomer",
  "id": "53",
  "attributes": {
    "createdAt": "2020-05-12T19:41:04.123Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "nationality": "US",
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-15",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    }
  },
  "relationships": {
    // ... relationships
  }
}
```

--------------------------------

### BusinessCustomer JSON:API Resource Example

Source: https://www.unit.co/docs/api/resources

A complete example of a BusinessCustomer resource object, including attributes and relationship definitions.

```json
{
  "type": "businessCustomer",
  "id": "1",
  "attributes": {
    "createdAt": "2020-05-10T12:28:37.698Z",
    "name": "Pied Piper",
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "businessVertical": "TechnologyMediaOrTelecom",
    "numberOfEmployees": "Between50And100",
    "annualRevenue": "Between500kAnd1m",
    "cashFlow": "Predictable",
    "countriesOfOperation": [
      "US",
      "CA"
    ],
    "website": "https://piedpiper.com",
    "stockSymbol": "PPI",
    "yearOfIncorporation": "2014",
    "operatingAddress": {
      "street": "5250 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "authorizedUsers": [
      {
        "fullName": {
          "first": "Jared",
          "last": "Dunn"
        },
        "email": "jared@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1555555590"
        },
        "canConnectWithAuthVendor": true
      },
      {
        "fullName": {
          "first": "Nelson",
          "last": "Bighetti"
        },
        "email": "nelson-bighetti@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1234567891"
        },
        "canConnectWithAuthVendor": true
      }
    ],
    "status": "Active",
    "eligibleProducts": [
      "Banking",
      "BillPay"
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "businessApplication",
        "id": "1"
      }
    },
    "officer": {
      "data": {
        "type": "officer",
        "id": "12"
      }
    },
    "beneficialOwners": {
      "data": [
        {
          "type": "beneficialOwner",
          "id": "45"
        }
      ]
    },
    "authorizedUserResources": {
      "data": [
        {
          "type": "authorizedUserResource",
          "id": "1"
        },
        {
          "type": "authorizedUserResource",
          "id": "2"
        }
      ]
    }
  }
}
```

--------------------------------

### Verify Account Response Examples

Source: https://www.unit.co/docs/api/accounts/deposit-accounts/api

Examples of successful API responses indicating whether an account match was found or not.

```json
{
  "data": {
    "exists": true,
    "account": {
      "type": "depositAccount",
      "id": "1000000",
      "attributes": {
        "createdAt": "2023-01-01T00:00:00.000Z",
        "name": "Peter Parker",
        "status": "Open",
        "routingNumber": "051000017",
        "accountNumber": "10000123",
        "currency": "USD",
        "balance": 10000,
        "hold": 0,
        "available": 10000,
        "tags": {}
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "individualCustomer",
            "id": "100"
          }
        },
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "bank": {
          "data": {
            "type": "bank",
            "id": "1"
          }
        }
      }
    }
  }
}
```

```json
{
  "data": {
    "exists": false
  }
}
```

--------------------------------

### Example Lending Program Extended Information Resource

Source: https://www.unit.co/docs/api/lending-programs/resources

This JSON object shows an example of Lending Program Extended Information. It provides additional details beyond the basic Lending Program resource, such as utilized and available credit.

```json
{
  "data": {
    "type": "lendingProgramExtendedInformation",
    "id": "12",
    "attributes": {
      "programSizeAvailable": 10899600,
      "programSizeAllocated": 400
    }
  }
}
```

--------------------------------

### IndividualApplication Resource Example

Source: https://www.unit.co/docs/api/resources

A JSON representation of an IndividualApplication resource showing attributes and relationships.

```json
{
  "type": "individualApplication",
  "id": "53",
  "attributes": {
    "createdAt": "2020-01-14T14:05:04.718Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "AwaitingDocuments",
    "occupation": "ArchitectOrEngineer",
    "annualIncome": "Between50kAnd100k",
    "sourceOfIncome": "EmploymentOrPayrollIncome",
    "message": "Waiting for you to upload the required documents.",
    "archived": false,
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        }
      ]
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}
```

--------------------------------

### Webhook List Response Example

Source: https://www.unit.co/docs/api/webhooks

Example JSON:API response structure for a successful list request.

```json
{
  "data": [
    {
      "type": "webhook",
      "id": "1",
      "attributes": {
        "createdAt": "2021-02-03T08:17:28.010Z",
        "label": "111",
        "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488c",
        "status": "Disabled",
        "contentType": "Json",
        "token": "",
        "subscriptionType": "OnlyAuthorizationRequest"
      }
    },
    {
      "type": "webhook",
      "id": "2",
      "attributes": {
        "createdAt": "2021-02-09T14:54:42.612Z",
        "label": "some label",
        "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",
        "status": "Enabled",
        "contentType": "Json",
        "token": "MyToken",
        "subscriptionType": "NotAuthorizationRequest"
      }
    }
  ]
}
```

--------------------------------

### ACH Counterparty List Response Example

Source: https://www.unit.co/docs/api/counterparties/api

Example of a successful 200 OK response containing an array of ACH counterparty resources.

```json
{
  "data": [
    {
      "type": "achCounterparty",
      "id": "8",
      "attributes": {
        "createdAt": "2020-05-13T09:07:47.645Z",
        "name": "Joe Doe",
        "routingNumber": "123456789",
        "accountNumber": "123",
        "accountType": "Checking",
        "type": "Person",
        "permissions": "CreditOnly"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "111111"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "limit": 20,
      "offset": 0
    }
  }
}
```

--------------------------------

### PinStatus Resource Example

Source: https://www.unit.co/docs/api/resources

A sample JSON:API representation of a PinStatus resource.

```json
{
  "data": {
    "type": "pinStatus",
    "attributes": {
      "status": "NotSet"
    }
  }
}
```

--------------------------------

### IndividualDebitCard resource example

Source: https://www.unit.co/docs/api/resources

A sample JSON representation of an IndividualDebitCard resource.

```json
{
  "type": "individualDebitCard",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "last4Digits": "1234",
    "expirationDate": "2022-05",
    "bin": "123456789",
    "shippingAddress": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "2"
      }
    },
    "customer": {
      "data": {
        "type": "individualCustomer",
        "id": "2"
      }
    }
  }
}
```

--------------------------------

### Account Holds Response Example

Source: https://www.unit.co/docs/api/accounts/deposit-accounts/api

Example JSON:API response containing an array of account hold resources and pagination metadata.

```json
{
  "data": [
    {
      "type": "accountHold",
      "id": "7345432",
      "attributes": {
        "createdAt": "2024-10-01T12:39:25.107Z",
        "expiredAt": "2024-10-10",
        "status": "Active",
        "amount": 4433,
        "description": "Dispute investigation hold"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "158853345"
          }
        }
      }
    },
    {
      "type": "accountHold",
      "id": "4445488",
      "attributes": {
        "createdAt": "2024-10-01T12:39:25.107Z",
        "expiredAt": "2024-10-10",
        "status": "PartiallyReleased",
        "amount": 5000,
        "remainingHoldAmount": 2500,
        "description": "Check deposit hold"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "158853345"
          }
        }
      }
    },
    {
      "type": "accountHold",
      "id": "6543453453",
      "attributes": {
        "createdAt": "2024-10-03T12:23:39.169Z",
        "releasedAt": "2024-10-10",
        "status": "Released",
        "amount": 3400,
        "expiredAt": "2024-10-10",
        "tags": {
          "tagKey": "tagValue"
        },
        "description": "Processor payout pending"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "158853345"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 100,
      "limit": 100,
      "offset": 0
    }
  }
}
```

--------------------------------

### Example AccountHold Resource

Source: https://www.unit.co/docs/api/resources

A sample JSON:API representation of an AccountHold resource.

```json
{
  "data": {
    "type": "accountHold",
    "id": "7345432",
    "attributes": {
      "createdAt": "2024-10-02T12:39:25.107Z",
      "expiredAt": "2024-10-10",
      "status": "Active",
      "amount": 4433,
      "description": "Account Hold Reason 1"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "158853345"
        }
      }
    }
  }
}
```

--------------------------------

### Example Receivable Resource

Source: https://www.unit.co/docs/api/resources

A sample JSON:API representation of a bankReceivable resource.

```json
{
  "data": {
    "type": "bankReceivable",
    "id": "5",
    "attributes": {
      "createdAt": "2024-12-08T08:58:55.515Z",
      "updatedAt": "2024-12-08T08:58:55.515Z",
      "originalAmount": 100,
      "remainingAmount": 100,
      "purchaseDueDate": "2023-05-25",
      "repaymentStatus": {
        "type": "notRepaid"
      }
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10002"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10027"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "154"
        }
      },
      "lendingProgram": {
        "data": {
          "type": "lendingProgram",
          "id": "15"
        }
      }
    }
  }
}
```

--------------------------------

### Get Expected ACH Completion Date Request

Source: https://www.unit.co/docs/api/payments/ach/originating/api

Example request to retrieve the expected completion date for an ACH credit payment.

```curl
curl -X POST 'https://api.s.unit.sh/payments/ach/expected-completion-date'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "achExpectedCompletionDate",
    "attributes": {
      "direction": "Credit",
      "amount": 10000,
      "sameDay": false
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "555"
        }
      }
    }
  }
}'
```

--------------------------------

### RestrictedResources JSON Example

Source: https://www.unit.co/docs/api/resources

Example of a RestrictedResources resource array containing card and account identifiers.

```json
[
  {
    "type": "card",
    "ids": [
      "630",
      "529"
    ]
  },
  {
    "type": "account",
    "ids": [
      "10000"
    ]
  }
]
```

--------------------------------

### Receivables List Response Example

Source: https://www.unit.co/docs/api/receivables-management/api

Example JSON:API response structure for a list of receivables.

```json
{
  "data": [
    {
      "type": "bankReceivable",
      "id": "5",
      "attributes": {
        "createdAt": "2024-12-08T08:58:55.515Z",
        "updatedAt": "2024-12-08T08:58:55.515Z",
        "version": 1,
        "originalAmount": 100,
        "remainingAmount": 100,
        "purchaseDueDate": "2023-05-25",
        "repaymentStatus": {
          "type": "notRepaid"
        }
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10002"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10027"
          }
        },
        "transaction": {
          "data": {
            "type": "transaction",
            "id": "154"
          }
        },
        "lendingProgram": {
          "data": {
            "type": "lendingProgram",
            "id": "15"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "limit": 100,
      "offset": 0
    }
  }
}
```

--------------------------------

### Create Onboarding Credit Application via cURL

Source: https://www.unit.co/docs/api/credit-applications/api

Use this cURL command to create an onboarding credit application. Ensure the Authorization header is set with a valid token and the JSON:API structure is maintained.

```bash
curl -X POST 'https://api.s.unit.sh/credit-applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "createOnboardingCustomerCreditApplication",
    "attributes": {},
    "relationships": {
      "application": {
        "data": {
          "type": "application",
          "id": "10002"
        }
      },
      "lendingProgram": {
        "data": {
          "type": "lendingProgram",
          "id": "1"
        }
      }
    }
  }
}'
```

--------------------------------

### BusinessVirtualDebitCard JSON Resource Example

Source: https://www.unit.co/docs/api/resources

A sample JSON object representing a BusinessVirtualDebitCard resource, including attributes and relationships.

```json
{
  "type": "businessVirtualDebitCard",
  "id": "9",
  "attributes": {
    "createdAt": "2020-05-13T09:42:21.857Z",
    "last4Digits": "2074",
    "expirationDate": "2022-05",
    "bin": "123456789",
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "email": "richard@piedpiper.com",
    "dateOfBirth": "2001-08-10",
    "ssn": "123456789",
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "businessCustomer",
        "id": "1"
      }
    }
  }
}
```

--------------------------------

### Update Transaction Tags Request Example

Source: https://www.unit.co/docs/api/transactions/api

Example JSON payload for updating the tags attribute of a transaction.

```json
{
  "data": {
    "type": "transaction",
    "attributes": {
      "tags": {
        "trackUserId": "1234"
      }
    }
  }
}
```

--------------------------------

### Lending Programs Response Example

Source: https://www.unit.co/docs/api/lending-programs/api

Represents a successful 200 OK response containing an array of lending program resources and pagination metadata.

```json
{
  "data": [
    {
      "type": "bankSponsoredChargeCardProgram",
      "id": "12",
      "attributes": {
        "createdAt": "2024-02-16T16:32:11.741Z",
        "name": "Unit Finance Inc - MyBank BankSponsored Lending Program",
        "programSizeLimit": 10900000
      }
    },
    {
      "type": "bankSponsoredChargeCardProgram",
      "id": "13",
      "attributes": {
        "createdAt": "2024-02-16T16:32:12.307Z",
        "name": "Unit Finance Inc - MyBank Lending Program",
        "programSizeLimit": 10900000
      }
    },
    {
      "type": "clientSponsoredChargeCardProgram",
      "id": "15",
      "attributes": {
        "createdAt": "2024-02-16T20:29:46.920Z",
        "name": "Unit Finance Inc - MyBank ClientSponsored Lending Program",
        "programSizeLimit": 10900000
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "limit": 100,
      "offset": 0
    }
  }
}
```

--------------------------------

### BusinessApplication JSON Resource Example

Source: https://www.unit.co/docs/api/resources

A complete JSON representation of a businessApplication resource, including attributes and relationships.

```json
{
  "type": "businessApplication",
  "id": "50",
  "attributes": {
    "createdAt": "2020-01-13T16:01:19.346Z",
    "name": "Pied Piper",
    "dba": null,
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "officer": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "ssn": "123456789",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555589"
      },
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "status": "Approved"
    },
    "beneficialOwners": [
      {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "ssn": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "phone": {
          "countryCode": "1",
          "number": "1555555589"
        },
        "email": "richard@piedpiper.com",
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between10kAnd25k",
        "sourceOfIncome": "EmploymentOrPayrollIncome",
        "status": "Approved"
      }
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    },
    "archived": false,
    "annualRevenue": "Between500kAnd1m",
    "numberOfEmployees": "Between50And100",
    "cashFlow": "Predictable",
    "yearOfIncorporation": "2014",
    "countriesOfOperation": [
      "US"
    ],
    "stockSymbol": "PPI",
    "businessVertical": "TechnologyMediaOrTelecom",
    "website": "https://www.piedpiper.com",
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents."
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        },
        {
          "type": "document",
          "id": "3"
        }
      ]
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}
```

--------------------------------

### Counterparty Balance Resource Example

Source: https://www.unit.co/docs/api/counterparties/resources

Provides balance information for a counterparty created with a Plaid processor token. Only available when the customer owns the counterparty account.

```json
{
  "type": "counterpartyBalance",
  "id": "8",
  "attributes": {
    "available": 100000,
    "current": 120000
  },
  "relationships": {
    "counterparty": {
      "data": {
        "type": "achCounterparty",
        "id": "8"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "111111"
      }
    }
  }
}
```

--------------------------------

### Update Webhook Request Example

Source: https://www.unit.co/docs/api/webhooks

Example JSON payload for a PATCH request to update a webhook's attributes.

```json
{
  "data": {
    "type": "webhook",
    "attributes": {
      "label": "some label",
      "contentType": "Json",
      "includeResources": true,
      "subscriptionType": "OnlyAuthorizationRequest"
    }
  }
}
```

--------------------------------

### Wallet Account Response Example

Source: https://www.unit.co/docs/api/wallets/api

Represents the JSON:API document structure returned upon successful creation of a wallet account.

```json
{
  "data": {
    "type": "walletAccount",
    "id": "42",
    "attributes": {
      "createdAt": "2000-05-11T10:19:30.409Z",
      "name": "Peter Parker",
      "status": "Open",
      "walletTerms": "walletDefault",
      "routingNumber": "812345678",
      "accountNumber": "1000000002",
      "currency": "USD",
      "balance": 10000,
      "hold": 0,
      "available": 10000,
      "tags": {
        "purpose": "Healthcare"
      }
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "45555"
        }
      }
    }
  }
}
```

--------------------------------

### Deposit Account Response Example

Source: https://www.unit.co/docs/api/accounts/deposit-accounts/api

Example JSON:API response structure for a successful deposit account retrieval.

```json
{
  "data": [
    {
      "type": "depositAccount",
      "id": "42",
      "attributes": {
        "createdAt": "2000-05-11T10:19:30.409Z",
        "name": "Peter Parker",
        "status": "Open",
        "depositProduct": "checking",
        "routingNumber": "812345678",
        "accountNumber": "1000000002",
        "currency": "USD",
        "balance": 10000,
        "hold": 0,
        "available": 10000,
        "tags": {
          "purpose": "tax"
        }
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "45555"
          }
        }
      }
    }
  ]
}
```

--------------------------------

### IndividualVirtualDebitCard JSON:API Resource Example

Source: https://www.unit.co/docs/api/resources

A sample JSON representation of an IndividualVirtualDebitCard resource, illustrating the required attributes and relationship structures.

```json
{
  "type": "individualVirtualDebitCard",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "last4Digits": "1234",
    "expirationDate": "2022-05",
    "bin": "123456789",
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "2"
      }
    },
    "customer": {
      "data": {
        "type": "individualCustomer",
        "id": "2"
      }
    }
  }
}
```

--------------------------------

### IndividualCustomer JSON Resource Example

Source: https://www.unit.co/docs/api/resources

A complete JSON representation of an IndividualCustomer resource, including attributes and relationship data.

```json
{
  "type": "individualCustomer",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-12T19:41:04.123Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "occupation": "ArchitectOrEngineer",
    "annualIncome": "Between50kAnd100k",
    "sourceOfIncome": "EmploymentOrPayrollIncome",
    "annualRevenue": "Between100kAnd200k",
    "numberOfEmployees": "Between2And5",
    "businessVertical": "TechnologyMediaOrTelecom",
    "website": "https://piedpiper.com",
    "status": "Active",
    "eligibleProducts": [
      "Banking",
      "BillPay"
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    },
    "authorizedUsers": [
      {
        "fullName": {
          "first": "Erlich",
          "last": "Backman"
        },
        "email": "erlich-backman@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1234567890"
        },
        "canConnectWithAuthVendor": true
      },
      {
        "fullName": {
          "first": "Nelson",
          "last": "Bighetti"
        },
        "email": "nelson-bighetti@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1234567891"
        },
        "canConnectWithAuthVendor": false
      }
    ]
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "individualApplication",
        "id": "8"
      }
    },
    "authorizedUserResources": {
      "data": [
        {
          "type": "authorizedUserResource",
          "id": "1"
        },
        {
          "type": "authorizedUserResource",
          "id": "2"
        }
      ]
    }
  }
}
```

--------------------------------

### Recurring Repayment Response Example

Source: https://www.unit.co/docs/api/recurring-repayments/api

Example of a successful JSON:API response body returned after disabling a recurring repayment.

```json
{
  "data": {
    "type": "recurringAchRepayment",
    "id": "2",
    "attributes": {
      "createdAt": "2024-02-13T11:06:23.680Z",
      "updatedAt": "2024-02-14T11:13:33.482Z",
      "schedule": {
        "startTime": "2024-02-13",
        "interval": "Monthly",
        "nextScheduledAction": "2024-03-29",
        "dayOfMonth": 29
      },
      "description": "ACH Repayments",
      "sameDay": false,
      "numberOfRepayments": 0,
      "status": "Disabled"
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "2"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10016"
        }
      },
      "creditAccount": {
        "data": {
          "type": "creditAccount",
          "id": "10005"
        }
      },
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "1"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}
```

--------------------------------

### Get PIN Status via cURL

Source: https://www.unit.co/docs/api/cards/api

Retrieves the current PIN status for a specific card using a GET request.

```bash
curl -X GET 'https://api.s.unit.sh/cards/5/secure-data/pin/status' \
-H "Authorization: Bearer ${TOKEN}"
```

--------------------------------

### Example Customer List Response

Source: https://www.unit.co/docs/api/customers/api

A sample JSON:API response containing both business and individual customer resources with pagination metadata.

```json
{
  "data": [
    {
      "type": "businessCustomer",
      "id": "1",
      "attributes": {
        "createdAt": "2020-05-10T12:28:37.698Z",
        "name": "Pied Piper",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "phone": {
          "countryCode": "1",
          "number": "1555555566"
        },
        "stateOfIncorporation": "DE",
        "ein": "123456789",
        "entityType": "Corporation",
        "contact": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "email": "richard@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "1555555566"
          }
        },
        "businessVertical": "TechnologyMediaOrTelecom",
        "numberOfEmployees": "Between50And100",
        "annualRevenue": "Between500kAnd1m",
        "cashFlow": "Predictable",
        "countriesOfOperation": [
          "US",
          "CA"
        ],
        "website": "https://piedpiper.com",
        "stockSymbol": "PPI",
        "yearOfIncorporation": "2014",
        "operatingAddress": {
          "street": "5231 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94301",
          "country": "US"
        },
        "status": "Active"
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "application": {
          "data": {
            "type": "businessApplication",
            "id": "1"
          }
        },
        "officer": {
          "data": {
            "type": "officer",
            "id": "12"
          }
        },
        "beneficialOwners": {
          "data": [
            {
              "type": "beneficialOwner",
              "id": "45"
            }
          ]
        }
      }
    },
    {
      "type": "individualCustomer",
      "id": "8",
      "attributes": {
        "createdAt": "2020-05-12T19:41:04.123Z",
        "fullName": {
          "first": "Peter",
          "last": "Parker"
        },
        "ssn": "721074426",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "state": "NY",
          "postalCode": "11375",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "email": "peter@oscorp.com",
        "phone": {
          "countryCode": "1",
          "number": "1555555566"
        },
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between50kAnd100k",
        "sourceOfIncome": "EmploymentOrPayrollIncome",
        "annualRevenue": "Between100kAnd200k",
        "numberOfEmployees": "Between2And5",
        "businessVertical": "TechnologyMediaOrTelecom",
        "website": "https://piedpiper.com",
        "status": "Active"
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "application": {
          "data": {
            "type": "individualApplication",
            "id": "8"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "limit": 100,
      "offset": 0
    }
  }
}
```

--------------------------------

### Get Barcode Image via cURL

Source: https://www.unit.co/docs/api/payments/cash-deposits/api

Retrieves a PNG image of a cash deposit barcode using a GET request.

```bash
curl -X GET 'https://api.s.unit.sh/cash-deposits/barcodes/123456789123456789000000000000/image' \
-H "Authorization: Bearer ${TOKEN}"
```

--------------------------------

### Get Authorization by ID via cURL

Source: https://www.unit.co/docs/api/cards-authorizations/api

Retrieves a specific authorization resource using a GET request with a bearer token.

```bash
curl -X GET 'https://api.s.unit.sh/authorizations/1' \
-H "Authorization: Bearer ${TOKEN}"
```

--------------------------------

### POST https://api.s.unit.sh/credit-applications

Source: https://www.unit.co/docs/api/credit-applications/api

Creates a new onboarding credit application. This endpoint supports idempotency to ensure that multiple identical requests result in a single application creation.

```APIDOC
## POST https://api.s.unit.sh/credit-applications

### Description
Create an onboarding credit application. Credit Application creation requests support Idempotency, ensuring that performing multiple identical requests will have the same result as a single request.

### Method
POST

### Endpoint
https://api.s.unit.sh/credit-applications

### Parameters
#### Request Body
- **aggregatorAccessTokens** (Array of string) - Optional - Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens.
- **annualIncome** (Integer (Cents)) - Optional - The annual income of the applicant.
- **numberOfEmployees** (NumberOfEmployees) - Optional - Number of employees of the business.
- **yearsInBusiness** (Integer) - Optional - Number of years the business has been in operation.
- **additionalUnderwritingData** (json) - Optional - Object containing key-value pairs of underwriting data per credit policy.
- **idempotencyKey** (string) - Optional - See Idempotency.
- **application** (Relationship) - Required - The Application for which this credit application applies to.
- **lendingProgram** (Relationship) - Required - The LendingProgram for which this credit application is related to.

### Request Example
{
  "data": {
    "type": "createOnboardingCustomerCreditApplication",
    "attributes": {},
    "relationships": {
      "application": {
        "data": {
          "type": "application",
          "id": "10002"
        }
      },
      "lendingProgram": {
        "data": {
          "type": "lendingProgram",
          "id": "1"
        }
      }
    }
  }
}
```

--------------------------------

### Retrieve Payment Response Example

Source: https://www.unit.co/docs/api/payments

Example of a successful 200 OK response containing an ACH payment resource and associated metadata.

```json
{
  "data": [
    {
      "type": "achPayment",
      "id": "50",
      "attributes": {
        "createdAt": "2020-01-13T16:01:19.346Z",
        "status": "Pending",
        "counterparty": {
          "routingNumber": "812345678",
          "accountNumber": "12345569",
          "accountType": "Checking",
          "name": "Jane Doe"
        },
        "description": "Funding",
        "direction": "Credit",
        "amount": 10000
      },
      "relationships": {
        "account": {
          "data": {
            "type": "depositAccount",
            "id": "555"
          }
        },
        "customer": {
          "data": {
            "type": "individualCustomer",
            "id": "99823"
          }
        },
        "counterparty": {
          "data": {
            "type": "counterparty",
            "id": "4567"
          }
        },
        "transaction": {
          "data": {
            "type": "transaction",
            "id": "4003"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "limit": 100,
      "offset": 0
    }
  }
}
```

--------------------------------

### Successful Response Example

Source: https://www.unit.co/docs/api/application-documents/api

The response returns a JSON:API document containing the updated resource details.

```json
{
  "data": {
    "type": "document",
    "id": "3",
    "attributes": {
      "documentType": "IdDocument",
      "status": "Approved",
      "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
      "name": "Richard Hendricks",
      "dateOfBirth": "2001-08-15"
    }
  }
}
```
Tokens:
Raw