application/start

Creates a new application.

Start a new application process for a given email.

Parameters

Name	Type	Constraints	Description
params	object
params.referrer	object
params.referrer.referrer_id	string		Your referer_id provided by Etana.
params.type	string		Application 's type. Only 'individual' is supported in current version.
params?.customerEmail	string		Email of the user that you want to start an application process.

Result

Name	Type	Constraints	Description
result	object
result?.application_id	string		Unique identifier of an application, use application/start to create a new application, use application/getApplications to get all of your applicationIds.
result?.status	string		Status of an application., one of : [incomplete, pending_review, pending_user, rejected, approved, pending_agreement ]
result?.messages	object
result?.messages?.scope	string		Scope of the message. One of [application, name, identity, residency, background, funding, political, ofac, custody_agreement]
result?.messages?.code	string		Response code
result?.messages?.message	string		Response message associatted with code.
result?.messages?.detail	array		Details 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_id	string		Indentifier of an individual profile.
result?.kyc_id	string		It's an internal synonymus of application_id.
result?.type	string		Application 's type.,Only 'individual' is supported in current version.

Errors

Code	Message	Description
1	Error message	Error description.

Request Example

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "application/start",
  "params": {
    "referrer": {
      "referrer_id": "6172c164750ad6626e6fa16c"
    },
    "type": "individual",
    "customerEmail": "your@email.com"
  }
}

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