Sign in

Sign up

Document

Institution

Institution

Institution endpoints

Get All

Description

Get all institutions.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

Example:

1
2
3
4
5
6
7
8
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Institution",
    name: "Fassport",
    logo: "https://fassport.co/logo.png",
    website: "https://fassport.co",
    phone: "555-555-5555"
}

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
}

Type:

Error object

Example:

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

Type:

Error object

Example:

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

get

/institution/

Request

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

Response

1
2
3
4
5
6
7
8
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Institution",
    name: "Fassport",
    logo: "https://fassport.co/logo.png",
    website: "https://fassport.co",
    phone: "555-555-5555"
}

Get by id

Description

Find the institution that matches the {institutionId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

institutionId

string

Required

Description:

The id of the institution

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Example:

1
2
3
4
5
6
7
8
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Institution",
    name: "Fassport",
    logo: "https://fassport.co/logo.png",
    website: "https://fassport.co",
    phone: "555-555-5555"
}

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
}

Type:

Error object

Example:

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

Type:

Error object

Example:

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

get

/institution/:institutionId

Request

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

Response

1
2
3
4
5
6
7
8
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Institution",
    name: "Fassport",
    logo: "https://fassport.co/logo.png",
    website: "https://fassport.co",
    phone: "555-555-5555"
}

Get events

Description

Get all the events for an institution. These events include things like user or project changes, {billing} events, any other related updates.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

institutionId

string

Required

Description:

Institution Identifier

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Description:

Returns all events for the Org.

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"
        }
    ]
}

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
}

Type:

Error object

Example:

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

Type:

Error object

Example:

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

get

/institution/:institutionId/events

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/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"
        }
    ]
}

Get documents

Description

Get all the documents for an institution. These documents include anything the institution has access to read.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

institutionId

string

Required

Description:

Institution Identifier

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Description:

Returns all documents for the Org.

Type:

Array of Document objects

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Document",
    entityType: "User",
    tags: [
        "2024",
        "W2"
    ],
    name: "Fassport",
    originalName: "Fassport",
    description: "Fassport",
    uploadedBy: "0f9c0b0b4f0c6b0017f0e3b1",
    uploadedAt: "2025-01-18T06:04:42.114Z",
    generatedBy: "0f9c0b0b4f0c6b0017f0e3b1",
    generatedAt: "2025-01-18T06:04:42.114Z",
    mimeType: "application/pdf",
    size: 1000
}

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
}

Type:

Error object

Example:

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

Type:

Error object

Example:

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

get

/institution/:institutionId/documents

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/documents \
    -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: "Document",
    entityType: "User",
    tags: [
        "2024",
        "W2"
    ],
    name: "Fassport",
    originalName: "Fassport",
    description: "Fassport",
    uploadedBy: "0f9c0b0b4f0c6b0017f0e3b1",
    uploadedAt: "2025-01-18T06:04:42.114Z",
    generatedBy: "0f9c0b0b4f0c6b0017f0e3b1",
    generatedAt: "2025-01-18T06:04:42.114Z",
    mimeType: "application/pdf",
    size: 1000
}

Update

Description

Update an institution.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

institutionId

string

Required

Description:

Institution Identifier

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

body

name

string

Required

Description:

Institution name

Example:

"Fassport"

Responses

Description:

Returns the updated institution.

Example:

1
2
3
4
5
6
7
8
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Institution",
    name: "Fassport",
    logo: "https://fassport.co/logo.png",
    website: "https://fassport.co",
    phone: "555-555-5555"
}

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
}

Type:

Error object

Example:

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

Type:

Error object

Example:

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

put

/institution/:institutionId

Request

1
2
3
4
5
curl https://app.fassport.co/api/v1/institution/:institutionId \
    -X PUT \
    -H 'Authorization: Bearer <token>' \
    -H \'Content-Type: application/json\' \
	--data-raw '{"name":"\"Fassport\""}'

Response

1
2
3
4
5
6
7
8
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "Institution",
    name: "Fassport",
    logo: "https://fassport.co/logo.png",
    website: "https://fassport.co",
    phone: "555-555-5555"
}

API

Document

support@fassport.co

Copyright © Fassport 2025 • Terms • Privacy •