Documentation Powered by ReDoc

Identity Proofing Service (1.0.0)

Download OpenAPI specification:Download

Authentication

auth

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

    Kount API Scope

KountIdentityProofingService

Assessment

Provide Assessment or Guidance

Authorizations:
auth (k1_integration_api)
Request Body schema: application/json
strategy
string

This is strategy name.

inquiryId
string

Unique identifier for the customer's case inquiry.

channel
string

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

deviceSessionId
string

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

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

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": {
    }
}

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": {
    }
}

Update

Update case based on the verification.

Request Body schema: application/json
inquiryId
string

Inquiry Id

authenticationId
string

Authentication Id

decision
string

Case decision based on the customer's information

tags
Array of strings

Custom tags array

notes
string

Notes related to the verification

externalAgent
string

External Agent

queue
string

Queue

verifiedFraud
boolean

Verified Fraud

rejectionCode
string

Rejection Code

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": "denied for fraud"
}

Response samples

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