Files
api/documentation/topics/generated/createSubuser.topic
T

79 lines
3.0 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Create a subuser registration" id="createSubuser">
<!-- AUTO-GENERATED, DO NOT EDIT -->
<p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
<chapter title="Endpoint" id="endpoint">
<code-block lang="http">POST /subusers/me</code-block>
</chapter>
<chapter title="Operation" id="operation">
<p>Operation ID: <code>createSubuser</code></p>
<p>Creates a subuser (driver) account using a company&#x27;s CVR and a phone number. Validates the
CVR via e-conomic, ensures the phone number is not already in use, and if SMS is enabled
sends a setup link by SMS for the user to complete registration.
</p>
</chapter>
<chapter title="Authentication" id="authentication"><p>No authentication required.</p></chapter>
<chapter title="Request Body" id="request-body">
<p>Required: yes.</p>
<p>Content type: <code>application/json</code></p>
<code-block lang="json">
{
&quot;properties&quot;: {
&quot;cvr&quot;: {
&quot;description&quot;: &quot;Danish CVR (8 digits)&quot;,
&quot;example&quot;: 12345678,
&quot;type&quot;: &quot;integer&quot;
},
&quot;phone&quot;: {
&quot;description&quot;: &quot;Phone number (415 digits, no leading +)&quot;,
&quot;example&quot;: 12345678,
&quot;type&quot;: &quot;integer&quot;
},
&quot;phone_country_code&quot;: {
&quot;description&quot;: &quot;Phone country code (13 digits)&quot;,
&quot;example&quot;: 45,
&quot;type&quot;: &quot;integer&quot;
}
},
&quot;required&quot;: [
&quot;cvr&quot;,
&quot;phone_country_code&quot;,
&quot;phone&quot;
],
&quot;type&quot;: &quot;object&quot;
}
</code-block>
</chapter>
<chapter title="Responses" id="responses">
<table>
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
<tr><td>200</td><td>Subuser created (or pending setup) and company identified</td><td>application/json</td></tr>
<tr><td>400</td><td></td><td></td></tr>
<tr><td>404</td><td></td><td></td></tr>
<tr><td>500</td><td></td><td></td></tr>
</table>
<p>Schema for response <code>200</code> (<code>application/json</code>):</p>
<code-block lang="json">
{
&quot;properties&quot;: {
&quot;customer_number&quot;: {
&quot;description&quot;: &quot;Matched e-conomic customer number&quot;,
&quot;example&quot;: 1000,
&quot;type&quot;: &quot;integer&quot;
},
&quot;cvr&quot;: {
&quot;example&quot;: 12345678,
&quot;type&quot;: &quot;integer&quot;
}
},
&quot;type&quot;: &quot;object&quot;
}
</code-block>
</chapter>
</topic>