Skip to main content

application/getApplicationStatus

Get a summary of the application (only status data).

Use this to know the status of application (without getting all sections data)

Parameters

NameTypeConstraintsDescription
paramsobject
params.referrerobject
params.referrer.referrer_idstringYour referer_id provided by Etana.
params?.application_idstringUnique identifier of an application, use application/start to create a new application, use application/getApplications to get all of your applicationIds.

Result

NameTypeConstraintsDescription
resultobject
result?.application_idstringUnique identifier of an application, use application/start to create a new application, use application/getApplications to get all of your applicationIds.
result?.statusstringStatus of an application., one of : [incomplete, pending_review, pending_user, rejected, approved, pending_agreement ]
result?.messagesobject
result?.messages?.scopestringScope of the message. One of [application, name, identity, residency, background, funding, political, ofac, custody_agreement ]
result?.messages?.codestringResponse code
result?.messages?.messagestringResponse message associatted with code.
result?.messages?.detailarrayDetails of a message. ,It is a list of user friendly message with more detail about the message it self
result?.messages?.detail[0]string
result?.profile_idstringIndentifier of an individual profile.
result?.kyc_idstringIt's an internal synonymus of application_id.
result?.typestringApplication 's type.,Only 'individual' is supported in current version.

Errors

CodeMessageDescription
1Error messageError description.

Request example

{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "application/getApplicationStatus",
"params": {
"referrer": {
"referrer_id": "6172c164750ad6626e6fa16c"
},
"application_id": "6172c164750ad6626e6fa16c"
}
}

Response example

{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"application_id": "6172c164750ad6626e6fa16c",
"status": "incomplete",
"messages": {
"scope": "name",
"code": "001",
"message": "...",
"detail": ["..."]
},
"profile_id": "6176ef9ded9b2f4661470112",
"kyc_id": "6176ef9ded9b2f4661470112",
"type": "individual"
}
}