logo

Address

Creating an Address entity provides the necessary information to identify and locate a physical address. It may be associated with an Identity entity or Business entity to provide a more complete picture of the parties involved.

Create an Address

Create an Address

Request
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Request Body schema: application/json
required
line1
string
line2
string
city
string
state
string
postal_code
string
country
string
Responses
201

Address was created successfully

post/entities/address
Request samples
application/json
{
  • "line1": "123 Example St",
  • "line2": "# 61157",
  • "city": "Minneapolis",
  • "state": "MN",
  • "postal_code": "55555",
  • "country": "USA"
}
Response samples
application/json
{
  • "id": 1,
  • "type": "address",
  • "data": {
    },
  • "page_info": "string"
}

List Addresses

List addresses for your platform. This endpoint supports pagination.

Request
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Responses
200

Successfully list addresses

get/entities/address
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "array",
  • "data": [
    ],
  • "page_info": {
    }
}
Update an Address
Update information about an Address


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Request Body schema: application/json
required
line1
string
 
line2
string
 
city
string
 
state
string
 
postal_code
string
 
country
string
 
Responses 
200
Address updated


patch/entities/address/{id}
Request samples 
application/json
{
  • "line1": "123 Example St",
  • "line2": "# 61157",
  • "city": "Minneapolis",
  • "state": "MN",
  • "postal_code": "55555",
  • "country": "USA"
}
Response samples 
application/json
{
  • "id": 1,
  • "type": "address",
  • "data": {
    },
  • "page_info": "string"
}
Get an Address
Get information about an Address


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Responses 
200
Get Address


get/entities/address/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "address",
  • "data": {
    },
  • "page_info": "string"
}
➔ Next to Document