KYC API EndpointsFlag

Set Entity Blacklist State.

Mark the entity as blacklisted or not with the ‘?set=’ query parameter as ‘true’ or ‘false’.

Path parameters

entityIdstringRequiredformat: "uuid"

The entityId returned previously from an earlier call to /check or /entity

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequiredformat: "uuid"
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.
X-Frankie-CustomerChildIDstringOptionalformat: "uuid"
If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children.
X-Frankie-ChannelstringOptional
Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: - api - portal - smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Query parameters

setbooleanRequired
Set the value of an entity flag.
reasonstringOptional
Set the reason for blacklisting. Valid values are: - "NO_REASON_SUPPLIED" - "FABRICATED_IDENTITY" - "IDENTITY_TAKEOVER" - "FALSIFIED_ID_DOCUMENTS" - "STOLEN_ID_DOCUMENTS" - "MERCHANT_FRAUD" - "NEVER_PAY_BUST_OUT" - "CONFLICTING_DATA_PROVIDED" - "MONEY_MULE" - "FALSE_FRAUD_CLAIM" - "FRAUDULENT_3RD_PARTY" - "COMPANY_TAKEOVER" - "FICTITIOUS_EMPLOYER" - "COLLUSIVE_EMPLOYER" - "OVER_VALUATION_OF_ASSETS" - "FALSIFIED_EMPLOYMENT_DETAILS" - "MANIPULATED_IDENTITY" - "SYNDICATED_FRAUD" - "INTERNAL_FRAUD" - "BANK_FRAUD" - "UNDISCLOSED_DATA" - "FALSE_HARDSHIP" - "SMR_REPORT_LODGED" - "2X_SMR_REPORTS_LODGED" - "CUSTOMER_REQUEST" - "ABUSIVE_CUSTOMER"
blockedBystringOptional
Specify who is setting the entity as blacklisted.
attributestringOptional
Specify the blacklisted attribute. Valid values are: - "ENTIRE_PROFILE" - "FULL_NAME" - "EMAIL_ADDRESS" - "PHONE_NUMBER" - "ID_DOCUMENT" - "MAILING_ADDRESS" - "RESIDENTIAL_ADDRESS"
originalIdstringOptional

Specify the Id of the matching blacklisted entity or single data-point.

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.

entityobject
Describes all of the data being used to verify an entity.
requestIdstringformat: "ulid"

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Errors