Get Evidence Form
GET
Get the evidence form for an evidence requirement on a customer's RFI, such as the source of funds behind one held payment, with the current submission if one was sent. Build the POST body from the form's fields and documents. Evidence is per payment: what was sent for an earlier payment does not answer this one.
header
X-Api-Key<token>API key in format: sti_env_prefix_secret
customerId*stringCustomer UUID
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidrfiId*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidrequirementId*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidDefault Response
application/json- response
rfi_id*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidrequirement_id*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidcustomer_id*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidrequired_evidence*stringsource_of_funds: the source of funds behind one held payment. ad_hoc: an item Stables compliance wrote for this request, answered with text or one document
Value in
"source_of_funds""ad_hoc"status*stringValue in
"pending""submitted""satisfied""waived"answerable*booleanWhether a submission is accepted now: the RFI is open and the evidence is not yet approved. A submission replaces the current one until compliance has reviewed it
rejection_reason?stringWhy Stables sent the evidence back; submit it again to clear it
form*The fields and documents to send, in the RequirementSchema shape. Build the POST body from fields[].key and documents[].wire_field
submission?The current submission, once one has been sent
limits*curl -X GET 'https://api.sandbox.stables.money/api/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/rfis/497f6eca-6276-4993-bfeb-53cbbbba6f08/requirements/497f6eca-6276-4993-bfeb-53cbbbba6f08/evidence'Example Response
{ "rfi_id": "67dff3e5-8fe4-4fc3-bd34-9ccc65996247", "requirement_id": "6bcf6ec7-61c3-4af0-a310-59616a4dac61", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "required_evidence": "source_of_funds", "status": "pending", "answerable": true, "rejection_reason": "string", "form": { "wire_key": "string", "version": -9007199254740991, "revision": "string", "title": "string", "description": "string", "customer_types": [ "INDIVIDUAL" ], "submission_description": "string", "sibling_wire_fields": [ "string" ], "sections": [ { "id": "string", "label": "string", "description": "string", "order": -9007199254740991 } ], "fields": [ { "key": "string", "code": "string", "section": "string", "order": -9007199254740991, "type": "string", "label": "string", "description": "string", "placeholder": "string", "example": "string", "required": true, "required_when": { "field": "string", "equals": "string" }, "visible_when": { "field": "string", "equals": "string" }, "validation": { "min": 0, "max": 0, "integer": true, "min_length": -9007199254740991, "max_length": -9007199254740991, "pattern": "string", "format": "email", "min_items": -9007199254740991, "max_items": -9007199254740991 }, "options": [ { "value": "string", "label": "string", "description": "string" } ], "currency": "string" } ], "documents": [ { "kind": "string", "code": "string", "section": "string", "order": -9007199254740991, "label": "string", "description": "string", "wire_field": "string", "scope": "container", "shape": "data_uri", "subtype_field": "string", "subtype_options": [ { "value": "string", "label": "string", "description": "string" } ], "accept": [ "string" ], "max_bytes": -9007199254740991, "min_count": -9007199254740991, "max_count": -9007199254740991, "max_count_per_subtype": -9007199254740991, "required": true, "required_when": { "field": "string", "equals": "string" }, "visible_when": { "field": "string", "equals": "string" }, "groups": [ { "id": "string", "code": "string", "label": "string", "description": "string", "required": true, "satisfied_by": [ "string" ] } ] } ], "beneficiaries": { "section": "string", "label": "string", "description": "string", "wire_field": "string", "ref_format": "opaque", "fields": [ { "key": "string", "order": -9007199254740991, "type": "string", "label": "string", "description": "string", "placeholder": "string", "example": "string", "required": true, "required_when": { "field": "string", "equals": "string" }, "visible_when": { "field": "string", "equals": "string" }, "validation": { "min": 0, "max": 0, "integer": true, "min_length": -9007199254740991, "max_length": -9007199254740991, "pattern": "string", "format": "email", "min_items": -9007199254740991, "max_items": -9007199254740991 }, "options": [ { "value": "string", "label": "string", "description": "string" } ], "currency": "string", "wire_path": "string" } ], "documents": [ { "kind": "string", "order": -9007199254740991, "label": "string", "description": "string", "shape": "data_uri", "subtype_field": "string", "subtype_options": [ { "value": "string", "label": "string", "description": "string" } ], "accept": [ "string" ], "max_bytes": -9007199254740991, "min_count": -9007199254740991, "max_count": -9007199254740991, "max_count_per_subtype": -9007199254740991, "required": true, "required_when": { "field": "string", "equals": "string" }, "visible_when": { "field": "string", "equals": "string" }, "wire_path": "string", "satisfied_by_base_evidence": "string" } ], "base_evidence": [ { "key": "string", "label": "string" } ] }, "property1": null, "property2": null }, "submission": { "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3", "submitted_at": "2019-08-24T14:15:22Z", "answers": { "property1": null, "property2": null }, "documents": [ { "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6", "kind": "string", "file_name": "string", "content_type": "string", "size_bytes": -9007199254740991 } ] }, "limits": { "request_max_bytes": -9007199254740991 }}Build the body for Submit Evidence from the form's fields and documents. Evidence applies to one payment: what you sent for an earlier payment does not answer this one.