Creditsafe Connect API Documentation

Return All Hits Of Searches Linked To A Profile

Return hits of the searches linked to a profile.

SecuritybearerToken

Request

path Parameters

profileId

required

string

Id of the profile

query Parameters

hitDecisions	Array of strings The hit decisions. It can be the collection of undecided, truematch, falsepositive, discarded
page	integer Default: 1 Starting page number.
pageSize	integer <int32> Default: 10 Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

get/compliance/kyc-protect/profiles/{profileId}/hits

Request samples

Response samples

application/json

{"items": [{"id": "string",
"hitScore": 0,
"name": "string",
"match": "string",
"countries": ["string"
],
"datasets": ["string"
],
"decision": "string",
"note": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "string",
"createdAt": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"datesOfBirth": ["string"
],
"pepTier": "string",
"profileImages": ["string"
],
"supersededHit": {"id": "string",
"hitScore": 0,
"name": "string",
"match": "string",
"countries": ["string"
],
"datasets": ["string"
],
"decision": "string",
"note": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "string",
"createdAt": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"datesOfBirth": ["string"
],
"pepTier": "string",
"profileImages": ["string"
]
},
"searchId": "string",
"searchType": "string"
}
],
"totalSize": 0
}

➔ Next to KYC AML Screening - Businesses / Performs An AML Search For A Business And Saves The Results To The Database