Noyo Differences API
The Differences API from Noyo — 13 operation(s) for differences.
OpenAPI Specification
openapi: 3.0.1
info:
description: APIs to manage and consume information about Carriers
title: Noyo Carrier Carrier Mapped Field Differences API
version: 1.0.0
servers: []
tags:
- name: Differences
paths:
/api/v1/differences:
get:
description: Returns a list of differences.
operationId: getDifferenceList
parameters:
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
- description: Comma-separated list of requested Difference UUIDs
in: query
name: id
required: false
schema:
type: string
- description: Filter out differences above this impact score
in: query
name: max_impact_score
required: false
schema:
type: integer
- description: Filter out differences below this impact score
in: query
name: min_impact_score
required: false
schema:
type: integer
- description: True if you want differences that still need to be resolved
in: query
name: is_open
required: false
schema:
type: boolean
- description: Comma separated object types you would like to filter on
in: query
name: object_type
required: false
schema:
example: employee,individual_enrollment
type: string
- description: The ID of the object you'd like to filter on
in: query
name: object_id
required: false
schema:
example: 2ce3b54a-2535-4803-b218-e6b44081d418
format: uuid
type: string
- description: The ID of the group you'd like to filter on
in: query
name: group_id
required: false
schema:
example: 8da8e28d-1dbe-44b4-a973-46e8fc191b6c
format: uuid
type: string
- description: Filter for only differences created before this date (exclusive)
in: query
name: created_before
required: false
schema:
example: 2020-12-1
type: string
- description: Filter for only differences created after this date (exclusive)
in: query
name: created_after
required: false
schema:
example: 2020-12-1
type: string
- description: Comma separated impact types you would like to filter on
in: query
name: impact_type
required: false
schema:
type: string
- description: show only differences with the given is_dismissed value
in: query
name: is_dismissed
required: false
schema:
type: boolean
- description: Show only differences that are or are not discrepancies
in: query
name: is_discrepancy
required: false
schema:
type: boolean
- description: The ID of the member snapshot you'd like to filter on
in: query
name: member_snapshot_id
required: false
schema:
example: 8da8e28d-1dbe-44b4-a973-46e8fc191b6c
format: uuid
type: string
- description: The attribute on which to sort
in: query
name: sort_by
required: false
schema:
type: string
- description: Either asc or desc, to denote the data's direction
in: query
name: sort_direction
required: false
schema:
type: string
- description: Include differences that are known to be unavailable at carrier
in: query
name: include_unavailable
required: false
schema:
type: boolean
- description: Comma separated difference classifications to filter differences by
in: query
name: classification
required: false
schema:
example: field_mismatch,missing_from_platform
type: string
- description: Comma separated difference types to filter differences by
in: query
name: type
required: false
schema:
example: new_hire,phone_number
type: string
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 2
total_records: 97
response:
- carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
version: be22f69e-84b5-4cb0-a66a-a763641861c1
- carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264983
difference_classification: field_mismatch
difference_type: ie_effective_end_date
discrepancy_time: 1698265071
employee_id: 05da283a-bf0c-4fb6-b3ca-d658350f0ee2
fields:
- carrier_value: '2023-10-31'
key: effective_end_date
platform_value: '9999-12-31'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: 21150bdf-478a-4ac8-a214-bdd413df984e
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1707342911
object_id: 751437b9-1380-485f-937b-d86cec916f3e
object_type: individual_enrollment
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1707342908
version: 44707efe-3900-48dc-a243-e9d3c0781f40
schema:
$ref: '#/components/schemas/PaginatedDifferencesResult'
description: Successful Response - Returns all matching differences
summary: Retrieves a list of differences.
tags:
- Differences
/api/v1/differences/assign:
put:
description: Batch assign differences
operationId: batchAssignDifferences
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchAssigneeUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDifferenceUpdateResponse'
description: Successful Response - Returns a list of IDs that were updated
summary: Batch assign differences
tags:
- Differences
/api/v1/differences/dismiss:
put:
description: Batch dismiss differences
operationId: batchDismissDifferences
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDismissalUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDifferenceUpdateResponse'
description: Successful Response - Returns a list of IDs that were updated
summary: Batch dismiss differences
tags:
- Differences
/api/v1/differences/reopen:
put:
description: Batch reopen differences
operationId: batchReopenDifferences
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDismissalUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDifferenceUpdateResponse'
description: Successful Response - Returns a list of IDs that were updated
summary: Batch reopen differences
tags:
- Differences
/api/v1/differences/{difference_id}:
get:
description: Returns a single difference.
operationId: getDifference
parameters:
- description: The unique ID of the difference to fetch
in: path
name: difference_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
sources:
- carrier_fetch_time: 1698264756
created: 1698264758
id: 0f50a532-7915-43d7-8aaa-f1d8171d21ce
is_discrepancy: false
last_seen: 1698264756
member_snapshot_id: 384ea7c2-fd54-4ac3-9b69-dff17910a302
modified: 1698264758
object_id: 3a51e82a-073b-4d74-b207-1669127723d9
object_type: member_transaction
resolves_difference: false
stage: member_snapshot_sent_to_noyo
suppress_discrepancies: false
version: db79b7b6-be47-403f-b7ab-0acd30369cc5
- carrier_fetch_time: 1698264940
created: 1698265348
id: d91263b8-ea8b-4292-b13c-1da162ebc0b4
is_discrepancy: false
last_seen: 1698264940
member_snapshot_id: 384ea7c2-fd54-4ac3-9b69-dff17910a302
modified: 1698265348
object_id: 3a51e82a-073b-4d74-b207-1669127723d9
object_type: member_transaction
resolves_difference: false
stage: member_snapshot_confirm
suppress_discrepancies: false
version: 7487692a-52b2-428a-b724-6fa110d6acca
- carrier_fetch_time: 1698265158
created: 1698265348
id: 124a9fcd-9431-41f0-a45e-a194dc078865
is_discrepancy: false
last_seen: 1698265158
member_snapshot_id: 384ea7c2-fd54-4ac3-9b69-dff17910a302
modified: 1698265348
object_id: 3a51e82a-073b-4d74-b207-1669127723d9
object_type: member_transaction
resolves_difference: false
stage: member_snapshot_confirm
suppress_discrepancies: false
version: e2fecf68-4cfc-4c8a-a964-ea6a1734e0cd
- carrier_fetch_time: 1698265273
created: 1698265349
id: 9ebb5b47-992a-4a7d-a533-282c819762f8
is_discrepancy: true
last_seen: 1698265273
member_snapshot_id: 384ea7c2-fd54-4ac3-9b69-dff17910a302
modified: 1698265349
object_id: 3a51e82a-073b-4d74-b207-1669127723d9
object_type: member_transaction
resolves_difference: false
stage: member_snapshot_confirm
suppress_discrepancies: false
version: 7733d5ee-c0da-4c8b-a484-1374c4daa2e7
- carrier_fetch_time: 1706815154
created: 1706815155
id: baf5824a-073c-4027-8c6e-d0b2ace050eb
is_discrepancy: false
last_seen: 1706815154
member_snapshot_id: feb720cb-e28e-41de-97a1-044bf31bc2f2
modified: 1706815155
object_id: 1562d508-4739-41e0-9f84-18a1c8fcbb99
object_type: member_transaction
resolves_difference: true
stage: member_snapshot_sent_to_noyo
suppress_discrepancies: false
version: 082a5b0e-4481-406b-9f71-cc5fe11825ae
version: be22f69e-84b5-4cb0-a66a-a763641861c1
schema:
$ref: '#/components/schemas/PublicSingleDifferenceResult'
description: Successful Response - Returns all difference
summary: Retrieves a single difference
tags:
- Differences
/api/v1/differences/{difference_id}/assign:
put:
description: Assign a difference
operationId: assignDifference
parameters:
- description: The unique ID of the difference to dismiss
in: path
name: difference_id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDifferenceAssigneeRequest'
required: true
responses:
'200':
content:
application/json:
example:
assignee_id: p2898ad7-02f8-414f-9f94-5a1acd535c27
carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: true
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
version: be22f69e-84b5-4cb0-a66a-a763641861c1
schema:
$ref: '#/components/schemas/BasicSingleDifferenceResult'
description: Successful Response - Returns the updated difference
summary: Assign a difference
tags:
- Differences
/api/v1/differences/{difference_id}/dismiss:
put:
description: Dismiss a difference
operationId: dismissDifference
parameters:
- description: The unique ID of the difference to dismiss
in: path
name: difference_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: true
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
version: be22f69e-84b5-4cb0-a66a-a763641861c1
schema:
$ref: '#/components/schemas/BasicSingleDifferenceResult'
description: Successful Response - Returns the updated difference
summary: Dismiss a difference
tags:
- Differences
/api/v1/differences/{difference_id}/reopen:
put:
description: Reopen a dismissed difference
operationId: reopenDifference
parameters:
- description: The unique ID of the difference to reopen
in: path
name: difference_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
version: be22f69e-84b5-4cb0-a66a-a763641861c1
schema:
$ref: '#/components/schemas/BasicSingleDifferenceResult'
description: Successful Response - Returns the updated difference
summary: Reopen a difference
tags:
- Differences
/api/v1/employees/{employee_id}/differences:
get:
description: Returns a list of differences for an employee.
operationId: getEmployeeDifferenceList
parameters:
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
- description: Show differences for this employee
in: path
name: employee_id
required: true
schema:
type: string
- description: Filter out differences above this impact score
in: query
name: max_impact_score
required: false
schema:
type: integer
- description: Filter out differences below this impact score
in: query
name: min_impact_score
required: false
schema:
type: integer
- description: True if you want differences that still need to be resolved
in: query
name: is_open
required: false
schema:
type: boolean
- description: Filter for only differences created before this date (exclusive)
in: query
name: created_before
required: false
schema:
example: Tue, 01 Dec 2020 00:00:00 GMT
type: string
- description: Filter for only differences created after this date (exclusive)
in: query
name: created_after
required: false
schema:
example: Tue, 01 Dec 2020 00:00:00 GMT
type: string
- description: Comma separated object types you would like to filter on
in: query
name: object_type
required: false
schema:
example: employee,individual_enrollment
type: string
- description: The ID of the object you'd like to filter on
in: query
name: object_id
required: false
schema:
example: 2ce3b54a-2535-4803-b218-e6b44081d418
format: uuid
type: string
- description: Comma separated impact types you would like to filter on
in: query
name: impact_type
required: false
schema:
type: string
- description: show only differences with the given is_dismissed value
in: query
name: is_dismissed
required: false
schema:
type: boolean
- description: Show only differences that are or are not discrepancies
in: query
name: is_discrepancy
required: false
schema:
type: boolean
- description: The ID of the member snapshot you'd like to filter on
in: query
name: member_snapshot_id
required: false
schema:
example: 8da8e28d-1dbe-44b4-a973-46e8fc191b6c
format: uuid
type: string
- description: The attribute on which to sort
in: query
name: sort_by
required: false
schema:
type: string
- description: Either asc or desc, to denote the data's direction
in: query
name: sort_direction
required: false
schema:
type: string
- description: Include differences that are known to be unavailable at carrier
in: query
name: include_unavailable
required: false
schema:
type: boolean
- description: Comma separated difference classifications to filter differences by
in: query
name: classification
required: false
schema:
example: field_mismatch,missing_from_platform
type: string
- description: Comma separated difference types to filter differences by
in: query
name: type
required: false
schema:
example: new_hire,phone_number
type: string
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 2
total_records: 97
response:
- carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
version: be22f69e-84b5-4cb0-a66a-a763641861c1
- carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264983
difference_classification: field_mismatch
difference_type: ie_effective_end_date
discrepancy_time: 1698265071
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '2023-10-31'
key: effective_end_date
platform_value: '9999-12-31'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: 21150bdf-478a-4ac8-a214-bdd413df984e
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1707342911
object_id: 751437b9-1380-485f-937b-d86cec916f3e
object_type: individual_enrollment
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1707342908
version: 44707efe-3900-48dc-a243-e9d3c0781f40
schema:
$ref: '#/components/schemas/PaginatedDifferencesResult'
description: Successful Response - Returns all matching differences for an employee
summary: Retrieves a list of differences belonging to a given employee.
tags:
- Differences
/api/v1/groups/{group_id}/differences:
get:
description: Returns a list of differences for a group.
operationId: getGroupDifferenceList
parameters:
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
- description: Show differences for this employee
in: path
name: group_id
required: true
schema:
type: string
- description: Filter out differences above this impact score
in: query
name: max_impact_score
required: false
schema:
type: integer
- description: Filter out differences below this impact score
in: query
name: min_impact_score
required: false
schema:
type: integer
- description: True if you want differences that still need to be resolved
in: query
name: is_open
required: false
schema:
type: boolean
- description: Comma separated object types you would like to filter on
in: query
name: object_type
required: false
schema:
example: employee,individual_enrollment
type: string
- description: Filter for only differences created before this date (exclusive)
in: query
name: created_before
required: false
schema:
example: Tue, 01 Dec 2020 00:00:00 GMT
type: string
- description: Filter for only differences created after this date (exclusive)
in: query
name: created_after
required: false
schema:
example: Tue, 01 Dec 2020 00:00:00 GMT
type: string
- description: The ID of the object you'd like to filter on
in: query
name: object_id
required: false
schema:
example: 2ce3b54a-2535-4803-b218-e6b44081d418
format: uuid
type: string
- description: Comma separated impact types you would like to filter on
in: query
name: impact_type
required: false
schema:
type: string
- description: show only differences with the given is_dismissed value
in: query
name: is_dismissed
required: false
schema:
type: boolean
- description: Show only differences that are or are not discrepancies
in: query
name: is_discrepancy
required: false
schema:
type: boolean
- description: The ID of the member snapshot you'd like to filter on
in: query
name: member_snapshot_id
required: false
schema:
example: 8da8e28d-1dbe-44b4-a973-46e8fc191b6c
format: uuid
type: string
- description: The attribute on which to sort
in: query
name: sort_by
required: false
schema:
type: string
- description: Either asc or desc, to denote the data's direction
in: query
name: sort_direction
required: false
schema:
type: string
- description: Include differences that are known to be unavailable at carrier
in: query
name: include_unavailable
required: false
schema:
type: boolean
- description: Comma separated difference classifications to filter differences by
in: query
name: classification
required: false
schema:
example: field_mismatch,missing_from_platform
type: string
- description: Comma separated difference types to filter differences by
in: query
name: type
required: false
schema:
example: new_hire,phone_number
type: string
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 2
total_records: 97
response:
- carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264758
difference_classification: field_mismatch
difference_type: dob
discrepancy_time: 1698265273
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '1989-01-12'
key: person.date_of_birth
platform_value: '1999-01-12'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: ac951a10-5115-4f1b-a374-5510d818fd07
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1706815155
object_id: d1898ad7-02f8-414f-9f94-5a1acd535c08
object_type: dependent
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1706815154
version: be22f69e-84b5-4cb0-a66a-a763641861c1
- carrier_id: 2d370e0e-fd73-45e0-8828-796d2cacaeef
created: 1698264983
difference_classification: field_mismatch
difference_type: ie_effective_end_date
discrepancy_time: 1698265071
employee_id: 556f553b-4626-419c-b26e-30bb69956eb0
fields:
- carrier_value: '2023-10-31'
key: effective_end_date
platform_value: '9999-12-31'
group_id: 26faa540-9ca3-454b-914e-a84701ea04cd
id: 21150bdf-478a-4ac8-a214-bdd413df984e
impact_score: 3
is_dismissed: false
is_suppressed: false
modified: 1707342911
object_id: 751437b9-1380-485f-937b-d86cec916f3e
object_type: individual_enrollment
organization_id: 34a3ac5b-fa32-4714-b2fe-2ff5a6a3e68c
resolved: 1707342908
version: 44707efe-3900-48dc-a243-e9d3c0781f40
schema:
$ref: '#/components/schemas/PaginatedDifferencesResult'
description: Successful Response - Returns all matching differences for a group
summary: Retrieves a list of differences belonging to a group.
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/noyo/refs/heads/main/openapi/noyo-differences-api-openapi.yml