Application

Business

Business endpoints

Get All

Description

Get all businesses.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

200

Type:

Array of Business objects

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/business/

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/ \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

Get by id

Description

Find the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Business object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/business/:businessId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/:businessId \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

Get events

Description

Get all events for the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Array of Event objects

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "updated",
    message: "User 0f9c0b0b4f0c6b0017f0e3b1 updated forwarder 0f9c0b0b4f0c6b0017f0e3b1",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    entity: "0f9c0b0b4f0c6b0017f0e3b1",
    entityType: "Application",
    refs: [
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Application"
        },
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Business"
        }
    ]
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/business/:businessId/events

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/:businessId/events \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "updated",
    message: "User 0f9c0b0b4f0c6b0017f0e3b1 updated forwarder 0f9c0b0b4f0c6b0017f0e3b1",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    entity: "0f9c0b0b4f0c6b0017f0e3b1",
    entityType: "Application",
    refs: [
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Application"
        },
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Business"
        }
    ]
}

Create

Description

Create a new business.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

body

name

string

Required

Description:

The business name

Example:

"Fassport"

displayName

string

Required

Description:

The business name

Example:

"Fassport Inc"

businessType

string

Required

Description:

The business description

Options:

Example:

"c-corporation"

dba

string

Required

Description:

The business description

Example:

"Fassport Inc"

ein

string

Required

Description:

The business description

Example:

"123456789"

phone

string

Required

Description:

The business description

Example:

"555-555-5555"

line1

Required

Description:

The business description

line2

Required

Description:

The business description

city

Required

Description:

The business description

state

Required

Description:

The business description

zip

Required

Description:

The business description

country

Required

Description:

The business description

website

string

Required

Description:

The business description

Example:

"https://fassport.co"

netWorth

number

Required

Description:

The business description

Example:

1000000

revenue

number

Required

Description:

The business description

Example:

1000000

parent

string

Required

Description:

The business description

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Business object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/business/

Request

1
2
3
4
5
curl https://app.fassport.co/api/v1/business/ \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -H \'Content-Type: application/json\' \
	--data-raw '{"name":"\"Fassport\"","displayName":"\"Fassport Inc\"","businessType":"\"c-corporation\"","dba":"\"Fassport Inc\"","ein":"\"123456789\"","phone":"\"555-555-5555\"","website":"\"https://fassport.co\"","parent":"\"0f9c0b0b4f0c6b0017f0e3b1\""}'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

Update

Description

Update the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

body

name

string

Required

Description:

The business name

Example:

"Fassport"

displayName

string

Required

Description:

The business name

Example:

"Fassport Inc"

businessType

string

Required

Description:

The business description

Options:

Example:

"c-corporation"

dba

string

Required

Description:

The business description

Example:

"Fassport Inc"

ein

string

Required

Description:

The business description

Example:

"123456789"

phone

string

Required

Description:

The business description

Example:

"555-555-5555"

line1

Required

Description:

The business description

line2

Required

Description:

The business description

city

Required

Description:

The business description

state

Required

Description:

The business description

zip

Required

Description:

The business description

country

Required

Description:

The business description

website

string

Required

Description:

The business description

Example:

"https://fassport.co"

netWorth

number

Required

Description:

The business description

Example:

1000000

revenue

number

Required

Description:

The business description

Example:

1000000

parent

string

Required

Description:

The business description

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Business object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/business/:businessId

Request

1
2
3
4
5
curl https://app.fassport.co/api/v1/business/:businessId \
    -X PUT \
    -H 'Authorization: Bearer <token>' \
    -H \'Content-Type: application/json\' \
	--data-raw '{"name":"\"Fassport\"","displayName":"\"Fassport Inc\"","businessType":"\"c-corporation\"","dba":"\"Fassport Inc\"","ein":"\"123456789\"","phone":"\"555-555-5555\"","website":"\"https://fassport.co\"","parent":"\"0f9c0b0b4f0c6b0017f0e3b1\""}'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

Delete

Description

Delete the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Business object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

delete

/business/:businessId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/:businessId \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    businessType: "c-corporation",
    name: "Fassport",
    dba: "Fassport Inc",
    displayname: "Fassport Inc",
    email: "biz@fassport.co",
    phone: "555-555-5555",
    website: "https://fassport.co",
    netWorth: 1000000,
    revenue: 1000000,
    ein: "123456789",
    parent: "0f9c0b0b4f0c6b0017f0e3b1",
    owners: {
        __type: "BusinessOwner",
        user: {
            key: "user",
            type: "string",
            example: "0f9c0b0b4f0c6b0017f0e3b1"
        },
        title: {
            key: "title",
            type: "string",
            example: "CEO"
        },
        equity: {
            key: "equity",
            type: "number",
            example: 100
        }
    }
}

Add Owner

Description

Add an owner to the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

BusinessOwner object

Example:

1
2
3
4
5
{
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    title: "CEO",
    equity: 100
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/business/:businessId/owner

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/:businessId/owner \
    -X POST \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
{
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    title: "CEO",
    equity: 100
}

Update Owner

Description

Update the owner of the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

ownerId

string

Required

Description:

The id of the owner

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

BusinessOwner object

Example:

1
2
3
4
5
{
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    title: "CEO",
    equity: 100
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/business/:businessId/owner

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/:businessId/owner \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
{
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    title: "CEO",
    equity: 100
}

Delete Owner

Description

Delete the owner of the business that matches the {businessId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

businessId

string

Required

Description:

The id of the business

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

ownerId

string

Required

Description:

The id of the owner

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

BusinessOwner object

Example:

1
2
3
4
5
{
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    title: "CEO",
    equity: 100
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

delete

/business/:businessId/owner

Request

1
2
3
4
curl https://app.fassport.co/api/v1/business/:businessId/owner \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
{
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    title: "CEO",
    equity: 100
}

Document

Application

support@fassport.co

Resources

Docs

Pricing

Roadmap

About

Integrations

Support

Sign-In

Sign-Up

Forgot Password

Contact

Schedule Demo