Documentation Powered by ReDoc

Identity Proofing Service (1.0.0)

Download OpenAPI specification:Download

This API uses OAuth2 Client Credentials flow. To obtain an access token, make a POST request to the token endpoint:

Token Request Example:

curl -X POST https://login.kount.com/oauth2/ausdppksgrbyM0abp357/v1/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Authorization: Basic {API KEY}" \
  -d "grant_type=client_credentials&scope=k1_integration_api"

Required Parameters:

  • grant_type: Must be "client_credentials"
  • scope: Must be "k1_integration_api"

Use the returned access_token in API requests: Authorization: Bearer {access_token}

Authentication

auth

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://login.kount.com/oauth2/ausdppksgrbyM0abp357/v1/token
Scopes:
  • k1_integration_api -

    Kount API Scope

KountIdentityProofingService

Provide Assessment or Guidance

This method provides assessment or guidance based on the identity proofing request.

Mandatory Request Headers

  • x-client-id: Unique client identifier. Example: 1234567890
  • x-correlation-id: Unique event identifier for tracking. Example: 2438ac3c-37eb-4902-adef-ed16b4431030
  • Content-Type: Request content type.
    Example: application/json
  • Authorization: Bearer token for API access.
    Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Authorizations:
auth (k1_integration_api)
Request Body schema: application/json
strategy
string (Required)

The name of the strategy.

inquiryId
string (Required)

The unique identifier for the customer's case inquiry.

channel
string (Recommended)

The unique identifier of the website or app and/or product where the inquiry originated.

deviceSessionId
string (Required)

Unique identifier for the customer's end-user's session on the site app. Must be the same session ID used in the device data collection from the client-side Kount SDK. Uniqueness for this property is not enforced, but customers should provide unique values.

creationDateTime
string

The date and time that the request was made.

userIp
string (Recommended)

The subject's (end-user's) IPv4 address (in dotted decimal notation), as identified by the customer/merchant.

object (v1Account)
object (v1Applicant)
object (v1CoApplicant)
object (v1Product)
object

key-value pair fileds sent by customer

memberId
string

Member id of the customer

Responses

Request samples

Content type
application/json
{
  • "strategy": "StrategyWithoutStepup",
  • "inquiryId": "511db65b-8a22-4daa-9320-98ff86371c6a",
  • "channel": "DEFAULT",
  • "deviceSessionId": "c12da910e8734aea856cd0fefb2be80d",
  • "creationDateTime": "2006-01-02T15:04:05.000Z",
  • "userIp": "147.146.254.32",
  • "account": {
    },
  • "applicant": {
    },
  • "coApplicant": {
    },
  • "product": {
    },
  • "customFields": {
    },
  • "memberId": "123456"
}

Response samples

Content type
application/json
{
  • "inquiryId": "223db65b-8a22-4daa-9320-98ff86371d8f",
  • "authenticationId": "74da67ab-1c80-431c-8249-91344c5fa778",
  • "deviceSessionId": "c12da910e8734aea856cd0fefb2be80d",
  • "decision": "Challenge",
  • "userSegment": "Default",
  • "tags": [
    ],
  • "scoreCards": [
    ],
  • "deviceId": "123456abc12345",
  • "entityId": "testEntity",
  • "insights": {
    },
  • "strategy": {
    },
  • "thirdPartyCalls": {
    },
  • "errorResponses": {
    },
  • "status": "string",
  • "message": "string",
  • "applicantCustomerIdentifier": "string",
  • "coApplicantCustomerIdentifier": "string"
}

Provide Document based verification

This method provides document-based verification for identity proofing.

Mandatory Request Headers

  • x-client-id: Unique client identifier. Example: 1234567890
  • x-correlation-id: Unique event identifier for tracking. Example: 2438ac3c-37eb-4902-adef-ed16b4431030
  • Content-Type: Request content type.
    Example: application/json
  • Authorization: Bearer token for API access.
    Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Authorizations:
auth (k1_integration_api)
Request Body schema: application/json
inquiryId
string

The inquiry Id

strategy
string

Strategy Name

phoneNumber
string

It's an Optional Field.

Responses

Request samples

Content type
application/json
{
  • "inquiryId": "inquiryId123",
  • "strategy": "StrategyWithStepup_DOC",
  • "phoneNumber": "123-456-7890"
}

Response samples

Content type
application/json
{}

Fetch query parameter based controlled document records.

This method fetches document verification records based on query parameters.

Mandatory Request Headers

  • x-client-id: Unique client identifier. Example: 1234567890
  • x-correlation-id: Unique event identifier for tracking. Example: 2438ac3c-37eb-4902-adef-ed16b4431030
  • Content-Type: Request content type.
    Example: application/json
  • Authorization: Bearer token for API access.
    Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
path Parameters
authenticationId
required
string

The unique, customer-generated identifier for the consumer’s original case inquiry

query Parameters
data
string

ocrData, scoreData, imageData, all

Type of data to retrieve

Responses

Response samples

Content type
application/json
{
  • "authenticationId": "ed66c7b0-8114-41fe-98d3-ffa6d3f095e5",
  • "ocrData": { },
  • "scoreData": { },
  • "imageData": { }
}

Update case based on the verification.

This method updates the case based on the verification results.

Mandatory Request Headers

  • x-client-id: Unique client identifier. Example: 1234567890
  • x-correlation-id: Unique event identifier for tracking. Example: 2438ac3c-37eb-4902-adef-ed16b4431030
  • Content-Type: Request content type.
    Example: application/json
  • Authorization: Bearer token for API access.
    Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
inquiryId
string (Required)

The unique, customer-generated identifier for the consumer’s original case inquiry. This should map to the original assessment that is being updated

authenticationId
string (Required)

A Kount 360 unique identifier returned in the body of the original assessment. This may also called the case ID.

decision
string (ALLOW, DENY, CHALLENGE, REVIEW)

The updated case decision. If no value is given, the decision will remain in its current state.

tags
Array of strings

Array of tags to be appended to the case. This is not validated against existing tags in the case management.

notes
string

Notes related to the verification

externalAgent
string

Reference to an agent or representative handling the case. This is not validated to internal Kount360 Portal users.

queue
string

The queue to which the case is to be assigned. This is validated against existing queues. If the designated queue does not exist, no change the queue assignment will be made

verifiedFraud
boolean

Indicator for reporting purposes that the case was verified as a fraudulent transaction

rejectionCode
string

A code identifying which rejection code will be assigned to the case. This code is validated against rejection codes created within the K360 Portal. If unable to validate, no rejection code change or assignment will be made to the case

Responses

Request samples

Content type
application/json
{
  • "inquiryId": "223db65b-8a22-4daa-9320-98ff86371d8f",
  • "authenticationId": "427e798a-835e-452f-ba0e-ad355d7fc604",
  • "decision": "Allow",
  • "tags": [
    ],
  • "notes": "passed document verification",
  • "externalAgent": "autogenerated",
  • "queue": "investigation",
  • "verifiedFraud": false,
  • "rejectionCode": "AC10"
}

Response samples

Content type
application/json
{
  • "inquiryId": "223db65b-8a22-4daa-9320-98ff86371d8f",
  • "correlationId": "a43db65b-8a22-4daa-9320-98ff86371c89",
  • "message": "successfully updated",
  • "error": {
    }
}