application/update
Updates an application name's section.
Parameters
Name | Type | Constraints | Description |
---|---|---|---|
params | object | ||
params.referrer | object | ||
params.referrer.referrer_id | string | Your referer_id provided by Etana. | |
params.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. | |
params.subsection | string | minLength="1" | Subsection to be updated. One of [name, identity, residency, background, funding, political, ofac, custody_agreement] |
params.data | string | minLength="1" | Object with all data to be updated. See SKD documentation more information. |
Result
Name | Type | Constraints | Description |
---|---|---|---|
result | object | ||
result?.responseStatus | string | Result of the request. [ok, err] | |
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?.data | string | Object with response data (depends on context) | |
result?.messages | array | ||
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 |
Errors
Code | Message | Description |
---|---|---|
1 | Error message | Error description. |
Request example
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "application/update",
"params": {
"referrer": {
"referrer_id": "6172c164750ad6626e6fa16c"
},
"application_id": "6172c164750ad6626e6fa16c",
"subsection": "name",
"data": {
"first": "your first name",
"last": "your last name",
"...": "..."
}
}
}
Response example
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"responseStatus": "ok",
"application_id": "6172c164750ad6626e6fa16c",
"data": {
"version": "0.0.1"
},
"messages": [
{
"scope": "name",
"code": "001",
"message": "...",
"detail": ["..."]
}
]
}
}