Get Onboarding Status

GET 
/api/v1/partner-profiles/account/:accountId

Call this endpoint to get the onboarding status of an account you added. You can add multiple documents at once. Authenticate with your bearer token.

Request

Path Parameters

accountId stringrequired

Id of the added account

Responses

200

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Code string

Message string

AdditionalInfo string

]

StatusCode int32required
TraceId string
IsSuccess booleanrequired

Account

object

AccountId stringrequired

AccountName stringrequired

AccountEmail stringrequired

ApprovedDate date-time

ParentId stringrequired

ParentName stringrequired

Status AccountStatuses (string)required

Possible values: [New, PendingApproval, Approved, Rejected, Synced, Failed]

Terminals

object[]

required

Array [

Name stringrequired

Apikey stringrequired

]

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true,
  "Account": {
    "AccountId": "string",
    "AccountName": "string",
    "AccountEmail": "string",
    "ApprovedDate": "2024-06-06T16:41:09.479Z",
    "ParentId": "string",
    "ParentName": "string",
    "Status": "New",
    "Terminals": [
      {
        "Name": "string",
        "Apikey": "string"
      }
    ]
  }
}

404

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Code string

Message string

AdditionalInfo string

]

StatusCode int32required
TraceId string
IsSuccess booleanrequired

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true
}

500

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Code string

Message string

AdditionalInfo string

]

StatusCode int32required
TraceId string
IsSuccess booleanrequired

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true
}

Loading...