Search
K
FGA-Service

Search for related cases and policies for a party

Searches and retrieves all related cases and/or policies for a given party ID

get
https://qa.api.zinnia.io/fga/v1/search-parties

Query Parameters

partyIdstringrequired

ID of the party to get related data for

filterTypestring

Filter to show only policies or cases related data

Allowed values:policiescases

maxDepthnumber

Maximum depth for recursive relationship fetching. Leave empty for unlimited depth.

excludeSourcestring

Exclude either entity or salesentity data sources from the results

Allowed values:entitysalesentity

directOnlyboolean

Return only direct party relationships. For policies: return direct party policies only. For cases: return direct party cases plus cases from direct party policies.

Response

application/json

Successfully retrieved related data

PartyRelatedDataResponse

partyIdstringrequired

party id for which related data is being retrieved

casesarray[string]

List of related case IDs

policiesarray[object]

List of related policies

Show Child Parameters
get/fga/v1/search-parties
 
application/json

Get user fraud score

Get user fraud score

get
https://qa.api.zinnia.io/fga/v1/frauds

Query Parameters

firstNamestringrequired
surNamestringrequired
countrystringrequired
mobileNumberstringrequired
emailstringrequired

Response

200 application/json

Fraud score and details

SocureFraudResponse

SocureFraudResponseobject
get/fga/v1/frauds
 
200 application/json

Search for users who have specific access to a particular queue for a carrier

Search for users who have specific access to a particular queue for a carrier

post
https://qa.api.zinnia.io/fga/v1/search-users

Body

application/json

SearchUsersRequest

carrierstringrequired

carrier name

Example:sbul

queuestringrequired

queue name

Example:new_business

accessstringrequired

access level

Allowed values:viewerprocessoradmin

Example:viewer

Response

200 application/json

Successfully retrieved ops users

SearchUsersResponse

usersarray[object]required

Example:[{"email":"example@example.com","firstName":"John","lastName":"Doe","id":"1234567890"}]

Show Child Parameters
post/fga/v1/search-users

Body

{ "carrier": "sbul", "queue": "new_business", "access": "viewer" }
 
200 application/json

Upsert a case

Synchronize a case’s authorization data

put
https://qa.api.zinnia.io/fga/v1/resources/cases/{caseId}

Path Parameters

caseIdstringrequired

Body

application/json

UpsertCaseDto

policyobject

Policy information

Show Child Parameters
carrierCodestring

Carrier code

Example:prud

salesEntitiesarray[object]

Sales entities associated with the case

Show Child Parameters
caseTypeGroupstring

Case type group classification

Example:claims

Response

200 application/json

Case authorization data set

UpsertCaseResponse

writtenarray[object]required

List of tuples that were written

Show Child Parameters
deletedarray[object]required

List of tuples that were deleted

Show Child Parameters
put/fga/v1/resources/cases/{caseId}

Body

{}
 
200 application/json

Cleanup terminated selling code access

Remove upline roles and hierarchy relationships for a terminated selling code.

post
https://qa.api.zinnia.io/fga/v1/upline-cleanup

Body

application/json

UplineCleanupRequest

carrierstringrequired

Carrier code used in salesentity/role tuple keys

Example:fnwl

sellingCodestringrequired

Selling code that has been terminated

Example:123456

terminationDatestringrequired

Termination date for the selling code (ISO 8601 date string)

Example:2026-04-01

Response

200 application/json

UplineCleanupResponse

tuplesDeletedarray[object]required
Show Child Parameters
post/fga/v1/upline-cleanup

Body

{ "carrier": "fnwl", "sellingCode": "123456", "terminationDate": "2026-04-01" }
 
200 application/json