processorIdentityGet

POST {{baseUrl}}/processor/identity/get

The /processor/identity/get endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

Request Body

{"processor_token"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;account&quot;:{&quot;account_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;balances&quot;:{&quot;available&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;current&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;limit&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;iso_currency_code&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;unofficial_currency_code&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;last_updated_datetime&quot;:&quot;\u003cstring,null\u003e&quot;},&quot;mask&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;official_name&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;subtype&quot;:&quot;\u003cstring,number\u003e&quot;,&quot;owners&quot;:[{&quot;names&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;phone_numbers&quot;:[{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}],&quot;emails&quot;:[{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}],&quot;addresses&quot;:[{&quot;data&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;data&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;}]},{&quot;names&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;phone_numbers&quot;:[{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}],&quot;emails&quot;:[{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;data&quot;:&quot;\u003cstring\u003e&quot;,&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}],&quot;addresses&quot;:[{&quot;data&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;data&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;primary&quot;:&quot;\u003cboolean\u003e&quot;}]}],&quot;verification_status&quot;:&quot;\u003cstring\u003e&quot;},&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;}