API Guide
Log In
API Guide

Create Organisation

post
https://api.partners.uat.crezco.com/organisations

Creates a single organisation within Crezco. Each organisation should represent a single company in the partner system. Organisations should have a unique partner id provided at creation. The partner id cannot be changed after the Organisation is created.

Body Params

An organisation is the root administrative object for a client. Each partner client has a single organisation. Each organisation must have a unique Partner Client Id. Only one organisation may exist per Partner Client Id. Each organisation also receives a unique Crezco ID.

string
required
length between 1 and 50

Unique ID of the client in the partner system. This is the unique ID of the client that owns the organisation in your system. Each organisation must have a unique Partner Client Id.

string
length ≤ 8

Company Registration Number (CRN) of the UK company as registered with companies house. This is a unique code that Companies House uses to help it quickly and correctly identify a company. A CRN is assigned upon incorporation, which means that limited companies and LLPs (limited liability partnerships) must have one.

Some other types of business do not require a CRN because they are not incorporated and are not required to file their statutory records with Companies House. Types of business not requiring a CRN include sole traders and general partnerships.

CRNs are always 8 characters long. These can be either 8 digits or 2 letters followed by 6 digits.

string
length ≤ 200

Name of the company that this organisation represents

users
array of objects
required
length ≥ 1

Collection of Users that belong to this organisation. Each organisation must have at least one User with the "Admin" role.

When submitting a PUT request for an organisation, any users which exist in Crezco but are not included in this collection will be marked as inactive. Any users which exist in this collection but not in Crezco will be created.

users*

Models a single user that belongs to an Organisation. Users are required as part of the Know Your Customer process. Each organisation must have at least one active user with the "Admin" role.

uuid | null

Unique ID for this user in Crezco. This field is required when updating an existing user. Omitting this field will cause a new user to be created.

string

Email address for this User. The email addresses do not need to be globally unique but must be unique within the context of each individual request, irrespective of case sensitivity.

string
required
length between 1 and 50

First name of this user. Where a user has multiple first names or middle names include them all in this field.

string
required
length between 1 and 50

Last name (surname) of this user.

string
required
length ≥ 1

The role that this user holds within the organisation. See our documentation for a list of acceptable roles

boolean

Is this user active within Crezco? All organisations must have at least one active user with the Admin role.

verification
object
Headers
string
Defaults to 2025-01-31

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Not Found

Updated 10 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 10 months ago