Submit a verification questionnaire

curl --request POST \
  --url https://api.sand.etherfuse.com/ramp/customer/{customer_id}/verification/questionnaire \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "occupation",
  "jobTitle": "Software Engineer",
  "industry": "4430200"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'occupation', jobTitle: 'Software Engineer', industry: '4430200'})
};

fetch('https://api.sand.etherfuse.com/ramp/customer/{customer_id}/verification/questionnaire', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sand.etherfuse.com/ramp/customer/{customer_id}/verification/questionnaire"

payload = {
    "type": "occupation",
    "jobTitle": "Software Engineer",
    "industry": "4430200"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "in_progress"
}

"tax_document: content type 'text/plain' is not supported (allowed: image/jpeg, image/jpg, image/png, application/pdf)"

KYC

Submit a verification questionnaire

Submit the customer’s answers to one questionnaire, named by type. Today the only one a partner can submit is occupation; type is required so that a second questionnaire can be added without invalidating requests already being sent.

`type`	Answers	Applies to
`occupation`	`jobTitle`, `industry`	Every customer

Documents are uploaded through POST /ramp/customer/{customer_id}/verification/documents, including a region’s tax document. The customer agreement is a questionnaire too and is deliberately absent: consent is collected interactively from the person giving it, in the hosted step.

Submit the customer’s personal data first, or this answers 409. As with document upload, the stage that asks these questions doesn’t exist on the customer until then.

Answers 202, not 200. industry is resolved against the live category list in the background, so an unrecognized value doesn’t fail the request: it leaves the occupation requirement outstanding.

POST

ramp

customer

{customer_id}

verification

questionnaire

Submit a verification questionnaire

curl --request POST \
  --url https://api.sand.etherfuse.com/ramp/customer/{customer_id}/verification/questionnaire \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "occupation",
  "jobTitle": "Software Engineer",
  "industry": "4430200"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'occupation', jobTitle: 'Software Engineer', industry: '4430200'})
};

fetch('https://api.sand.etherfuse.com/ramp/customer/{customer_id}/verification/questionnaire', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sand.etherfuse.com/ramp/customer/{customer_id}/verification/questionnaire"

payload = {
    "type": "occupation",
    "jobTitle": "Software Engineer",
    "industry": "4430200"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "in_progress"
}

"tax_document: content type 'text/plain' is not supported (allowed: image/jpeg, image/jpg, image/png, application/pdf)"

Authorizations

Authorization

string

header

required

API key sent in the Authorization header.

Path Parameters

customer_id

string<uuid>

required

The customer (child org) ID. Must belong to the caller's organization or a direct child.

Body

application/json

type

enum<string>

required

Which questionnaire these answers are for. New values may be added; a request naming one that does not exist is rejected listing the ones that do.

Available options:

occupation

Example:

"occupation"

jobTitle

string

required

The customer's occupation, free text.

Example:

"Software Engineer"

industry

string

required

Occupation category: a code from GET /ramp/verification/occupations. The label is not accepted; it is display copy and can be reworded.

Example:

"4430200"

Response

Accepted and being applied. The customer's current verification status is returned.

Where the customer's verification stands after a partner write. status is the same value GET /ramp/customer/{customer_id}/kyc reports, so there is one vocabulary across both.

customerId

string<uuid>

required

status

enum<string>

required

The customer's overall verification status. A write never moves it on its own.

Available options:

not_started,

in_progress,

submitted,

approved,

denied

Upload verification documents Import a verified session

⌘I

User Authentication

Ramp API

Lookup API

Submit a verification questionnaire

Authorizations

Path Parameters

Body

Response