Identity API (1.3.0)

Download OpenAPI specification:

User account management and authentication service.

User

Create a user

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Request Body schema: application/json
required

email required	string
name	string
surname	string
password required	string
phone	string
isMobilePhone	boolean
gender	string
birthdate	string
tracking required	Array of arrays
	object

Responses

Request samples

Payload

Content type

application/json

{"email": "none@uscca.com",
"name": "John",
"surname": "Doe",
"password": "Pa$$word",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "male",
"birthdate": "1970-01-01",
"tracking": {"tID": "63fd170c95413",
"origin": "test",
"medium": "test",
"campaign": "test",
"audience": "test",
"targeting": "test",
"type": "test",
"pageType": "test"
},
"meta": {"label": "string",
"fbc": "string",
"fbp": "string",
"gaClickID": "string",
"gaClientID": "string",
"twclid": "string"
}
}

Response samples

Content type

application/json

{"data": {"type": "users",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"idpId": "e61e8180-33be-4436-b762-983216f1faa2",
"name": "John",
"surname": "Smith",
"email": "john.smith@gmail.com",
"password": "Pa$$worD123",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "Male",
"birthdate": "1980-01-01",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
},
"relationships": {"token": {"data": {"type": "tokens",
"id": "3907acc6-b92b-11ed-820e-02420a000107"
}
},
"idpToken": {"data": {"type": "idp_tokens",
"id": "a87e9f87-3765-4467-b92e-31b347973d1d"
}
}
},
"include": [{"type": "tokens",
"id": "3907acc6-b92b-11ed-820e-02420a000107",
"attributes": {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"ttl": 1677826289
}
},
{"type": "idp_tokens",
"id": "a87e9f87-3765-4467-b92e-31b347973d1d",
"attributes": {"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"expiresAt": 1677826289
}
}
]
}
}

Find a User

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
X-Auth-Token required	string Default: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": {"type": "users",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"idpId": "e61e8180-33be-4436-b762-983216f1faa2",
"name": "John",
"surname": "Smith",
"email": "john.smith@gmail.com",
"password": "Pa$$worD123",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "Male",
"birthdate": "1980-01-01",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Update a User

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Auth-Token required	string Default: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request Body schema: application/json
required

idpId	string <uuid>
email	string
name	string
surname	string
password	string
phone	string
isMobilePhone	boolean
gender	string
birthdate	string

Responses

Request samples

Payload

Content type

application/json

{"idpId": "e61e8180-33be-4436-b762-983216f1faa2",
"email": "none@uscca.com",
"name": "John",
"surname": "Doe",
"password": "Pa$$word",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "male",
"birthdate": "1970-01-01"
}

Response samples

Content type

application/json

{"data": {"type": "users",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"idpId": "e61e8180-33be-4436-b762-983216f1faa2",
"name": "John",
"surname": "Smith",
"email": "john.smith@gmail.com",
"password": "Pa$$worD123",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "Male",
"birthdate": "1980-01-01",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Determine if an Email Exists

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Request Body schema: application/json
required

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "none@uscca.com"
}

Response samples

Content type

application/json

{"data": {"type": "users",
"id": ""
}
}

Admin: Retrieve a collection of Users

Authorizations:

X-Api-Token

query Parameters

filter required	string Examples: filter=filter[attribute][_eq]=foo - filter=filter[attribute][_neq]=bar - filter=filter[attribute][_lt]=2023-01-01 00:00:00 - filter=filter[attribute][_lte]=2023-01-01 00:00:00 - filter=filter[attribute][_gt]=2023-01-01 00:00:00 - filter=filter[attribute][_gte]=2023-01-01 00:00:00 - filter=filter[attribute][_in]=foo,bar,baz - filter=filter[attribute][_nin]=foo,bar,baz - filter=filter[attribute][_starts_with]=foo - filter=filter[attribute][_ends_with]=foo - filter=filter[attribute][_contains]=foo - filter=filter[relationship][_has][column][_eq]=foo -
page	integer Example: page=1
perPage	integer Example: perPage=50
sortBy	string Example: sortBy=foo
sort	string Example: sort=desc

header Parameters

Accept required	string Default: application/json
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: password
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

200
401
404
406
422

Content type

application/json

{"links": {"self": "/_users?filter[id][_in]=0384177a-f6a5-11ee-a4dc-0242ac120005&page=1&perPage=10",
"first": "/_users?filter[id][_in]=0384177a-f6a5-11ee-a4dc-0242ac120005&page=1&perPage=10",
"previous": null,
"next": null,
"last": "/_users?filter[id][_in]=0384177a-f6a5-11ee-a4dc-0242ac120005&page=1&perPage=10"
},
"data": [{"type": "users",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"idpId": "e61e8180-33be-4436-b762-983216f1faa2",
"name": "John",
"surname": "Smith",
"email": "john.smith@gmail.com",
"password": "Pa$$worD123",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "Male",
"birthdate": "1980-01-01",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"meta": {"total": 1,
"count": 1,
"perPage": 10,
"currentPage": 1,
"totalPages": 1
}
}

Admin: Find a User

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: password

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": {"type": "users",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"idpId": "e61e8180-33be-4436-b762-983216f1faa2",
"name": "John",
"surname": "Smith",
"email": "john.smith@gmail.com",
"password": "Pa$$worD123",
"phone": "111-222-3333",
"isMobilePhone": true,
"gender": "Male",
"birthdate": "1980-01-01",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Emergency Contact

Create Emergency Contact for User

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Auth-Token required	string Default: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request Body schema: application/json
required

name required	string <= 120 characters
phone required	string <phone> ^([0-9]{3})[-]([0-9]{3})[-]([0-9]{4})$
relationship required	string Enum: "Child" "Co-Worker" "Family Member" "Friend" "Parent" "Partner" "Spouse" "Unknown"

Responses

Request samples

Payload

Content type

application/json

{"name": "Emergency Contact Name",
"phone": "765-123-4567",
"relationship": "Friend"
}

Response samples

Content type

application/json

{"data": {"type": "emergency_contacts",
"id": "02771b78-87ba-4ab6-af89-d8cdcc43ba06",
"attributes": {"userId": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"name": "Emergency Contact Name",
"phone": "765-123-4567",
"relationship": "Friend",
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Find Emergency Contacts for User

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
X-Auth-Token required	string Default: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": [{"type": "emergency_contacts",
"id": "02771b78-87ba-4ab6-af89-d8cdcc43ba06",
"attributes": {"userId": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"name": "Emergency Contact Name",
"phone": "765-123-4567",
"relationship": "Friend",
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
]
}

Update Emergency Contact for User

Authorizations:

X-Api-Token

path Parameters

id required	string Example: fe0d9fc0-9975-43f2-b638-853a323505ca
emergency-contact-id required	string <uuid> Example: 02771b78-87ba-4ab6-af89-d8cdcc43ba06

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Auth-Token required	string Default: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request Body schema: application/json
required

name	string <= 120 characters
phone	string <phone> ^([0-9]{3})[-]([0-9]{3})[-]([0-9]{4})$
relationship	string Enum: "Child" "Co-Worker" "Family Member" "Friend" "Parent" "Partner" "Spouse" "Unknown"

Responses

Request samples

Payload

Content type

application/json

{"name": "Emergency Contact Name",
"phone": "765-123-4567",
"relationship": "Friend"
}

Response samples

Content type

application/json

{"data": {"type": "emergency_contacts",
"id": "02771b78-87ba-4ab6-af89-d8cdcc43ba06",
"attributes": {"userId": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"name": "Emergency Contact Name",
"phone": "765-123-4567",
"relationship": "Friend",
"createdAt": "2024-01-01 12:00:00",
"updatedAt": "2024-01-01 12:00:00"
}
}
}

Delete Emergency Contact for User

Authorizations:

X-Api-Token

path Parameters

id required	string Example: fe0d9fc0-9975-43f2-b638-853a323505ca
emergency-contact-id required	string <uuid> Example: 02771b78-87ba-4ab6-af89-d8cdcc43ba06

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Auth-Token required	string Default: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Responses

Response samples

401
404
406
415

Content type

application/json

Example

Missing/Invalid API Token

{"errors": [{"status": 401,
"title": "Unauthorized",
"detail": "The API token is missing or invalid."
}
]
}

Auth Tokens

Authenticate

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Request Body schema: application/json
required

email required	string
password required	string
ttl	integer
meta	object

Responses

Request samples

Payload

Content type

application/json

{"email": "none@uscca.com",
"password": "Pa$$word123",
"ttl": 1678165594,
"meta": { }
}

Response samples

200
401
406
415
422

Content type

application/json

{"data": {"type": "tokens",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"ttl": 1677826289
},
"relationships": {"idpToken": {"data": {"type": "idp_tokens",
"id": "a87e9f87-3765-4467-b92e-31b347973d1d"
}
}
},
"include": [{"type": "idp_tokens",
"id": "a87e9f87-3765-4467-b92e-31b347973d1d",
"attributes": {"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"expiresAt": 1677826289
}
}
]
}
}

Verifications

Generate a Verification Token

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Request Body schema: application/json
required

email required	string
source	string or null

Responses

Request samples

Payload

Content type

application/json

{"email": "none@uscca.com",
"source": "uscca"
}

Response samples

201
401
406
415
422

Content type

application/json

{"data": {"type": "verifications",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"expiresAt": "2022-01-01 12:00:00",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Verify a Verification Code

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Request Body schema: application/json
required

code required	integer
meta	object

Responses

Request samples

Payload

Content type

application/json

{"code": 123456,
"meta": { }
}

Response samples

Content type

application/json

{"data": {"type": "tokens",
"id": "ce47840d-4499-4dfc-b20e-6f11aef625b7",
"attributes": {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"ttl": 1677826289
}
}
}

Account Setup

Authorizations:

X-Api-Token

path Parameters

id

required

string

Example: fe0d9fc0-9975-43f2-b638-853a323505ca

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

401
406
415

Content type

application/json

{"errors": [{"status": 401,
"title": "Unauthorized",
"detail": "The API token is missing or invalid."
}
]
}

Identity API (1.3.0)

User

Create a user

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Find a User

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update a User

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Determine if an Email Exists

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Admin: Retrieve a collection of Users

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Admin: Find a User

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Emergency Contact

Create Emergency Contact for User

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Find Emergency Contacts for User

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update Emergency Contact for User

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Emergency Contact for User

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Auth Tokens

Authenticate

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verifications

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required