Ubiquity Consumers

List Employers

get/ubiquity/data-furnishing/consumers/{consumerId}/employers/{config}
SecurityAuthorization Token
Request
path Parameters
consumerId
required
string
config
required
string
Responses
200

Successful Get Employer List Response

Request samples 
Response samples 
application/json
[
]
Create Employer
post/ubiquity/data-furnishing/consumers/{consumerId}/employers/{config}
SecurityAuthorization Token 
Request 
path Parameters
consumerId
required
string
 
config
required
string
 
Request Body schema: application/json
id
string
 
name
string
 
address
string
 
unit
string
 
city
string
 
zipCode
string
 
state
string
 
occupation
string
 
Responses 
200
Successful Create Employer Response


Request samples 
application/json
{
}
Response samples 
application/json
{
}
List Consumers
get/ubiquity/data-furnishing/consumers/{config}
SecurityAuthorization Token 
Request 
path Parameters
config
required
string
 
Responses 
200
Successful Get Consumer List Response


Request samples 
Response samples 
application/json
[
]
Create Consumer
post/ubiquity/data-furnishing/consumers/{config}
SecurityAuthorization Token 
Request 
path Parameters
config
required
string
 
Request Body schema: application/json
id
string
 
externalId
string
 
isActive
boolean
 
firstName
string
 
middleName
string
 
lastName
string
 
suffix
string
 
dob
string
 
ssn
string
 
address
string
 
unit
string
 
city
string
 
zipCode
string
 
state
string
 
addressIndicator
string
 Enum: "" "C" "Y" "N" "M" "S" "B" "U" "D" "P"  
residenceCode
string
 Enum: "O" "R"  
countryCode
string
 
telephone
string
 
created
string
 
object (Employer) 
 
Responses 
200
Successful Create Consumer Response


Request samples 
application/json
{
}
Response samples 
application/json
{
}
Get Consumer
get/ubiquity/data-furnishing/consumers/{id}/{config}
SecurityAuthorization Token 
Request 
path Parameters
id
required
string
 
config
required
string
 
Responses 
200
Successful Get Consumer By Id Response


Request samples 
Response samples 
application/json
{
}
Update Consumer
put/ubiquity/data-furnishing/consumers/{id}/{config}
SecurityAuthorization Token 
Request 
path Parameters
id
required
string
 
config
required
string
 
Request Body schema: application/json
id
string
 
externalId
string
 
isActive
boolean
 
firstName
string
 
middleName
string
 
lastName
string
 
suffix
string
 
dob
string
 
ssn
string
 
address
string
 
unit
string
 
city
string
 
zipCode
string
 
state
string
 
addressIndicator
string
 Enum: "" "C" "Y" "N" "M" "S" "B" "U" "D" "P"  
residenceCode
string
 Enum: "O" "R"  
countryCode
string
 
telephone
string
 
created
string
 
object (Employer) 
 
Responses 
200
Successful Update Consumer By Id Response


Request samples 
application/json
{
}
Get Employer
get/ubiquity/data-furnishing/consumers/{consumerId}/employers/{employerId}/{config}
SecurityAuthorization Token 
Request 
path Parameters
consumerId
required
string
 
employerId
required
string
 
config
required
string
 
Responses 
200
Successful Get Employer By Id Response


Request samples 
Response samples 
application/json
{
}
Update Employer
put/ubiquity/data-furnishing/consumers/{consumerId}/employers/{employerId}/{config}
SecurityAuthorization Token 
Request 
path Parameters
consumerId
required
string
 
employerId
required
string
 
config
required
string
 
Request Body schema: application/json
id
string
 
name
string
 
address
string
 
unit
string
 
city
string
 
zipCode
string
 
state
string
 
occupation
string
 
Responses 
200
Successful Update Employer By Id Response


Request samples 
application/json
{
}