Skip to main content

KYC Partner Status Response

This API is called by the KYC partnet in response to initiate KYC response.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

response object REQUIRED

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

loanApplicationId string REQUIRED
kyc object REQUIRED
kycRefNo string
description string
business object
type string

Possible values: [CKYC, UDYAM, OFFLINE_AADHAAR]

scale string

Possible values: [MICRO, SMALL, MEDIUM]

category string

Possible values: [SERVICE, MANUFACTURING]

name string
address object
hba string REQUIRED
srl string REQUIRED
landmark string
als string
vtc string
pinCode string REQUIRED
po string
district string
state string REQUIRED
country string REQUIRED
url string
latitude string
longitude string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

email string
phoneNumber string
incorporationDate date
commencementDate date
udyam object
registrationNumber string
registrationDate date
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

status string

Possible values: [SUCCESS, REJECTED, PENDING, ACTION_REQUIRED]

extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

individual object
type string

Possible values: [CKYC, UDYAM, OFFLINE_AADHAAR]

name string
dob string
address object
hba string REQUIRED
srl string REQUIRED
landmark string
als string
vtc string
pinCode string REQUIRED
po string
district string
state string REQUIRED
country string REQUIRED
url string
latitude string
longitude string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

status string

Possible values: [SUCCESS, REJECTED, PENDING, ACTION_REQUIRED]

email string
phoneNumber string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

next object
type string

Possible values: [REDIRECT]

data object
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string