For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference - Partner API
      • POSTCreate an Onboarding
      • GETGet an Onboarding by Merchant Reference
      • GETGet an Onboarding by Onboarding ID
      • PUTUpdate an Onboarding
      • GETGet Activations
      • Capabilities
      • Channel
      • Owner
      • Business
      • Onboarding
      • PostOnboardingResponse
      • OnboardingPostPut
LogoLogo
Reference - Partner APIOnboardings

Onboarding

Example
1{
2  "onboardingId": "123abcd-456efgh-1124bd",
3  "updatedAt": "2024-02-21T09:50:36.871+00:00",
4  "merchantReference": "merchantId123",
5  "parentMerchantReference": "merchantPlatform",
6  "legalBusinessName": "merchantBusiness",
7  "storeName": "merchantName",
8  "website": "https://www.testmerchant.com",
9  "platform": "BLOCK",
10  "industry": "8299",
11  "aveTimeToShip": "Less than 1 Week",
12  "registeredCountry": "US",
13  "countryOfOperations": "US",
14  "businessType": "corporation",
15  "ein": "string",
16  "selfFulfillment": true,
17  "address1": "123 Main St",
18  "address2": "string",
19  "city": "London",
20  "state": "CA",
21  "postCode": "12345",
22  "email": "youremail@testmerchant.com",
23  "settlementContractId": "1a2b3c4d5e12xy34z",
24  "owners": [
25    {
26      "firstName": "Sam",
27      "lastName": "Merchant",
28      "dob": "2023-02-21",
29      "taxId": "TaxId123",
30      "jobTitle": "CEO",
31      "owns25": true,
32      "significantResponsibility": false,
33      "address1": "123 Main St",
34      "address2": "Apt 1403",
35      "city": "New York",
36      "state": "NY",
37      "postCode": "10011",
38      "countryCode": "US"
39    }
40  ]
41}
Was this page helpful?
Previous

PostOnboardingResponse

Next
Built with

Response

onboardingobjectRequired