> For the complete documentation index, see [llms.txt](https://api-docs.visadoc.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.visadoc.co/api-reference/applicants.md).
# Applicants
## Create an user (a traveller or a manager) so they can be placed on a visa application. Returns the new profile in its initial state — un-onboarded and unverified — because this call only creates the record; the onboarding invitation is a separate flow, so the person can't act until that completes.
> Create an user (a traveller or a manager) so they can be placed on a visa application. Returns the new profile in its initial state — un-onboarded and unverified — because this call only creates the record; the onboarding invitation is a separate flow, so the person can't act until that completes.\
> \
\
\
> \Authentication:\ required
```json
{"openapi":"3.0.0","info":{"title":"v3","version":"0.0.1"},"servers":[{"url":"https://api.visadoc.co/api:v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/applicants/new":{"post":{"operationId":"v3/applicants/new|POST","summary":"Create an user (a traveller or a manager) so they can be placed on a visa application. Returns the new profile in its initial state — un-onboarded and unverified — because this call only creates the record; the onboarding invitation is a separate flow, so the person can't act until that completes.","description":"Create an user (a traveller or a manager) so they can be placed on a visa application. Returns the new profile in its initial state — un-onboarded and unverified — because this call only creates the record; the onboarding invitation is a separate flow, so the person can't act until that completes.\n
\nAuthentication: required","tags":["applicants"],"parameters":[],"responses":{"200":{"description":"Success!","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":""},"created_at":{"type":"integer","format":"int64","description":""},"name":{"type":"string","description":"","nullable":true},"first_name":{"type":"string","description":""},"last_name":{"type":"string","description":""},"email":{"type":"string","description":""},"role":{"type":"string","description":"","enum":["Manager","Applicant","superAdmin","Admin","Sales"]},"onboarded":{"type":"boolean","description":"","default":"false"},"created_by":{"type":"string","format":"uuid","description":"","nullable":true}}}}}},"400":{"description":"Input Error. Check the request payload for issues."},"401":{"description":"Unauthorized"},"403":{"description":"Access denied. Additional privileges are needed access the requested resource."},"404":{"description":"Not Found. The requested resource does not exist."},"429":{"description":"Rate Limited. Too many requests."},"500":{"description":"Unexpected error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"","format":"email"},"first_name":{"type":"string","description":""},"last_name":{"type":"string","description":""},"role":{"type":"string","description":"","enum":["Applicant","Manager"]},"company_name":{"type":"string","description":""}},"required":["email","first_name","last_name","role"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"","format":"email"},"first_name":{"type":"string","description":""},"last_name":{"type":"string","description":""},"role":{"type":"string","description":"","enum":["Applicant","Manager"]},"company_name":{"type":"string","description":""}},"required":["email","first_name","last_name","role"]}}}}}}}}
```
## List all the applicants. Scope is role-dependent. Find or pick the traveller an application will be created for. Supports filters, page, per\_page (returns an array; set per\_page explicitly).
> List all the applicants. Scope is role-dependent. Find or pick the traveller an application will be created for. Supports filters, page, per\_page (returns an array; set per\_page explicitly).\
> \
\
\
> \Authentication:\ required
```json
{"openapi":"3.0.0","info":{"title":"v3","version":"0.0.1"},"servers":[{"url":"https://api.visadoc.co/api:v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/applicants/search":{"post":{"operationId":"v3/applicants/search|POST","summary":"List all the applicants. Scope is role-dependent. Find or pick the traveller an application will be created for. Supports filters, page, per_page (returns an array; set per_page explicitly).","description":"List all the applicants. Scope is role-dependent. Find or pick the traveller an application will be created for. Supports filters, page, per_page (returns an array; set per_page explicitly).\n
\nAuthentication: required","tags":["applicants"],"parameters":[],"responses":{"200":{"description":"Success!","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":""},"first_name":{"type":"string","description":""},"last_name":{"type":"string","description":""},"email":{"type":"string","description":""},"role":{"type":"string","description":"","enum":["Manager","Applicant","superAdmin","Admin","Sales"]},"avatar_url":{"type":"string","description":"","nullable":true},"onboarded":{"type":"boolean","description":"","default":"false"},"email_verified":{"type":"boolean","description":"","default":"false"},"created_by":{"type":"string","format":"uuid","description":"","nullable":true}}}}}}},"400":{"description":"Input Error. Check the request payload for issues."},"401":{"description":"Unauthorized"},"403":{"description":"Access denied. Additional privileges are needed access the requested resource."},"404":{"description":"Not Found. The requested resource does not exist."},"429":{"description":"Rate Limited. Too many requests."},"500":{"description":"Unexpected error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer","format":"int64","description":""},"per_page":{"type":"integer","format":"int64","description":""},"filters":{"type":"object","description":"","nullable":true}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"page":{"type":"integer","format":"int64","description":""},"per_page":{"type":"integer","format":"int64","description":""},"filters":{"type":"object","description":"","nullable":true}}}}}}}}}}
```
## Return the full profile of one traveller, including the saved default profile used to pre-fill future assessments and applications. Use it for the traveller-detail view and as the source of pre-fill data when starting a new case for them.
> Return the full profile of one traveller, including the saved default profile used to pre-fill future assessments and applications. Use it for the traveller-detail view and as the source of pre-fill data when starting a new case for them. \
> \
\
\
> \Authentication:\ required
```json
{"openapi":"3.0.0","info":{"title":"v3","version":"0.0.1"},"servers":[{"url":"https://api.visadoc.co/api:v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/applicants/{applicant_id}":{"get":{"operationId":"v3/applicants/{applicant_id}|GET","summary":"Return the full profile of one traveller, including the saved default profile used to pre-fill future assessments and applications. Use it for the traveller-detail view and as the source of pre-fill data when starting a new case for them. ","description":"Return the full profile of one traveller, including the saved default profile used to pre-fill future assessments and applications. Use it for the traveller-detail view and as the source of pre-fill data when starting a new case for them. \n
\nAuthentication: required","tags":["applicants"],"parameters":[{"name":"applicant_id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success!","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":""},"created_at":{"type":"integer","format":"int64","description":""},"first_name":{"type":"string","description":""},"last_name":{"type":"string","description":""},"email":{"type":"string","description":""},"role":{"type":"string","description":"","enum":["Manager","Applicant","superAdmin","Admin","Sales"]},"avatar_url":{"type":"string","description":"","nullable":true},"company_name":{"type":"string","description":""},"default_profile":{"type":"string","format":"uuid","description":"","nullable":true}}}}}},"400":{"description":"Input Error. Check the request payload for issues."},"401":{"description":"Unauthorized"},"403":{"description":"Access denied. Additional privileges are needed access the requested resource."},"404":{"description":"Not Found. The requested resource does not exist."},"429":{"description":"Rate Limited. Too many requests."},"500":{"description":"Unexpected error"}}}}}}
```
## DELETE /applicants/{applicant\_id}
> \
\
\
> \Authentication:\ required
```json
{"openapi":"3.0.0","info":{"title":"v3","version":"0.0.1"},"servers":[{"url":"https://api.visadoc.co/api:v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/applicants/{applicant_id}":{"delete":{"operationId":"v3/applicants/{applicant_id}|DELETE","summary":"","description":"
\nAuthentication: required","tags":["applicants"],"parameters":[{"name":"applicant_id","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success!","content":{"application/json":{"schema":{"type":"object","description":""}}}},"400":{"description":"Input Error. Check the request payload for issues."},"401":{"description":"Unauthorized"},"403":{"description":"Access denied. Additional privileges are needed access the requested resource."},"404":{"description":"Not Found. The requested resource does not exist."},"429":{"description":"Rate Limited. Too many requests."},"500":{"description":"Unexpected error"}}}}}}
```