Respond to an email onboarding information request
Allows organization owners and admins to submit a text response and up to three evidence uploads for the current information request.
POST
Allows organization owners and admins to submit a text response and up to three evidence uploads for the current information request.
apiKeyheader
x-api-key<token>application/json- body
expectedGeneration*integerRange
0 < value <= 9007199254740991responseText*stringLength
1 <= length <= 4000evidenceMediaIds*array<>Items
items <= 3OnboardingReviewStatus
application/json- response
decision*stringValue in
"undecided""approved""rejected"trustTier*stringValue in
"screened""probation""established"stage*stringValue in
"collecting""automated_review""manual_review""information_requested""complete"generation*integerRange
-9007199254740991 <= value <= 9007199254740991canSend*booleancode*|nullnextAction*|nullcanReapply*booleaninformationRequest*|nullidentities*array<>updatedAt*string|nullimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.respondToOnboardingInformationRequest({ "expectedGeneration": 1, "responseText": "example", "evidenceMediaIds": [ "example" ]});Example Response
{ "decision": "undecided", "trustTier": "screened", "stage": "collecting", "generation": -9007199254740991, "canSend": true, "code": "review_required", "nextAction": "wait_for_review", "canReapply": true, "informationRequest": { "id": "string", "requestedFields": [ "string" ], "requestedAt": "string", "canRespond": true }, "identities": [ { "identityId": "string", "decision": "undecided", "generation": -9007199254740991, "canSend": true, "code": "review_required", "nextAction": "wait_for_review", "updatedAt": "string" } ], "updatedAt": "string"}