Onboard

POST 
https://api.publicsquare.com/onboarding/:product

Starts the onboarding process for a product in the Account.

Permissions

• business:write

Request

Path Parameters

product stringrequired

Responses

200

OK

application/json

Schema

Schema

account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
productstringnullable
Product
Example: payments
onboarding_statusstringnullable
Onboarding status of the account
Example: verified
contract_statusstringnullable
Status of the contract review
Example: completed
step_requirements object[]nullable
Step requirements and their completion status
Array [
namestringnullable
Name of the required onboarding step
Example: business
statusstringnullable
Status of the contract review
Example: complete
]
document_requirements object[]nullable
Document requirements and their completion status
Array [
document_idstringnullable
Document ID
document_filenamestringnullable
Filename of the document
Example: sample.pdf
document_type object
valuestringnullable
Business document type
Example: articles_of_incorporation
namestringnullable
Business document type name
Example: Articles of incorporation
descriptionstringnullable
Business document type description
Example: Government issued document showing proof of business or articles of incorporation
additional_informationstringnullable
Additional information for this document type
Example: Please provide as much as you have available. Note: Limited data may lengthen the underwriting and approval process
opt_out_descriptionstringnullable
Description of how to opt out of this document type
Example: I confirm that my state does not require me to provide this document
can_opt_outboolean
Whether the user can opt out of this document type
Example: true
max_allowed_filesint32
Maximum number of files allowed for this document type
document_urlstringnullable
Url to download the document type
Example: https://www.irs.gov/pub/irs-pdf/fw9.pdf
statusstringnullable
Status of the contract review
Example: complete
entity_idstringnullable
ID of the entity or person the document is associated with
Example: rep_5mQSxcSAW3UZ4ijLzEt4RuAib
entity_typestringnullable
Type or role of entity the document is associated with
Example: business_representative
]

Example (auto)

{
  "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
  "product": "payments",
  "onboarding_status": "verified",
  "contract_status": "completed",
  "step_requirements": [
    {
      "name": "business",
      "status": "complete"
    }
  ],
  "document_requirements": [
    {
      "document_id": "string",
      "document_filename": "sample.pdf",
      "document_type": {
        "value": "articles_of_incorporation",
        "name": "Articles of incorporation",
        "description": "Government issued document showing proof of business or articles of incorporation",
        "additional_information": "Please provide as much as you have available. Note: Limited data may lengthen the underwriting and approval process",
        "opt_out_description": "I confirm that my state does not require me to provide this document",
        "can_opt_out": true,
        "max_allowed_files": 0,
        "document_url": "https://www.irs.gov/pub/irs-pdf/fw9.pdf"
      },
      "status": "complete",
      "entity_id": "rep_5mQSxcSAW3UZ4ijLzEt4RuAib",
      "entity_type": "business_representative"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errors objectnullable
property name* string[]
Array [
string
]
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "errors": {},
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyscopes: business:writedescription: Authorization by API Key inside request's X-API-KEY headerin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.publicsquare.com/onboarding/:product");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.publicsquare.com

Auth

ApiKey

Parameters

product — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!