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 [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Account

object

AccountIdstringrequired

AccountNamestringrequired

AccountEmailstringrequired

ApprovedDatedate-time

ParentIdstringrequired

ParentNamestringrequired

StatusAccountStatuses (string)required

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

Terminals

object[]

required

Array [

Namestringrequired

Apikeystringrequired

]

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-07-29T15:51:28.071Z",
    "ParentId": "string",
    "ParentName": "string",
    "Status": "New",
    "Terminals": [
      {
        "Name": "string",
        "Apikey": "string"
      }
    ]
  }
}

404

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

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 [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Example (from schema)

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