Skip to main content
POST
/
back-office
/
onboard
/
entity
Onboard New Entity
curl --request POST \
  --url https://api.example.com/back-office/onboard/entity \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": {
    "email": "[email protected]",
    "name": "<string>",
    "slug": "<string>",
    "phoneNumber": "<string>",
    "website": "<string>"
  },
  "hyfin": [
    {
      "hyfinAPIBaseUrl": "<string>",
      "hyfinSiteId": "<string>",
      "token": "<string>"
    }
  ],
  "integrations": [
    {
      "serviceTypeId": "<string>",
      "hyfinSiteId": "<string>",
      "configuration": "<unknown>"
    }
  ],
  "user": {
    "name": "<string>",
    "email": "[email protected]",
    "password": "<string>"
  }
}
'
{
  "data": {
    "organization": {
      "email": "[email protected]",
      "name": "<string>",
      "slug": "<string>",
      "id": "<string>",
      "phoneNumber": "<string>",
      "website": "<string>"
    },
    "hyfin": [
      {
        "hyfinAPIBaseUrl": "<string>",
        "hyfinSiteId": "<string>",
        "token": "<string>"
      }
    ],
    "integrations": [
      {
        "serviceTypeId": "<string>",
        "hyfinSiteId": "<string>",
        "configuration": "<unknown>"
      }
    ],
    "user": {
      "name": "<string>",
      "email": "[email protected]",
      "password": "<string>",
      "id": "<string>"
    },
    "id": "<string>",
    "apiKey": "<string>"
  },
  "code": "health_status_ok",
  "message": "<string>"
}

Body

application/json

Onboard request body

​
organization
object
required
​
hyfin
object[]
required
​
integrations
object[]
required
​
user
object
required

Response

Successfully onboarded new entity

​
data
object
required
​
code
enum<string>
Available options:
health_status_ok,
health_status_error,
validation_error,
bad_request,
unauthorized,
forbidden,
not_found,
method_not_allowed,
internal_server_error,
organization_not_found,
cannot_access_organization,
api_key_not_found,
resource_already_exists
​
message
string