Skapa en registreringsprofil

Skapa profilen en gång

Denna begäran skapar en lokal registreringsprofil tillsammans med operatörens identitets- och adressposter. Börja med de aktuella registreringsländerna, nummertyperna och kraven. Kraven beror på det land och den nummertyp du planerar att registrera.

Ett lyckat svar på skapandet är inte ett myndighetsgodkännande eller en nummeraktivering. Spara dokumentets UUID, identitets-ID och adress-ID separat: de har olika syften. Denna begäran ändrar kontodata och är inte en operation som enbart validerar.

Begäran om skapande

Autentisera med ditt aktiverade MultiTEL API-konto och dess tillåtna IP-adress. Exemplen använder HTTP Basic-autentiseringsuppgifter som lagras i miljövariabler. Kontrollera både HTTP-svaret och JSON-fältet status.code; ett HTTP 200-svar ensamt styrker inte att anropet lyckades. Alla exempelvärden är fiktiva.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile.json \
  https://api.multitel.net/v3/create_document

{
  "identity_type": "Personal",
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "country": "US",
  "address": "1 Example Street",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}

JSON-exemplet är en illustrativ Personal-profil, inte en verklig identitet som är klar att skickas in. Ersätt dess uppgifter och signatur med den slutanvändarinformation som krävs enligt de valda registreringsreglerna. Formulärkodad indata stöds också.

Fält i registreringsprofilen
Fält	Obligatoriskt och format
`identity_type`	Obligatoriskt. Använd det exakta värdet Personal eller Business; den villkorliga valideringen beror på versaler och gemener.
`first_name, last_name`	Obligatoriskt, vardera högst 64 tecken. För ett företag anger du de uppgifter om företrädaren som det valda landet kräver.
`phone_number`	Obligatoriskt numeriskt telefonvärde, minst åtta tecken. Ett internationellt nummer med enbart siffror inklusive landskod passar för denna validering; detta är ett kontaktnummer, inte ett nummerköp.
`city, postal_code, address`	Obligatoriskt, vardera högst 64 tecken.
`country`	Obligatorisk ISO-kod för adresslandet från registreringskatalogen. Tjänsten översätter den till operatörens landspost.
`signature`	Obligatoriska signaturdata. Den nuvarande portalen skickar Base64-kodade PNG-bildbyte utan prefixet data:image/png;base64,. Hämta slutanvändarens signatur via ditt auktoriserade arbetsflöde; en icke-tom platshållare är inte en meningsfull signatur.
`nationality`	Obligatoriskt för Personal, som en ISO-landskod. Ersätt den inte med ett lands-UUID.
`company_name, incorporation_country`	Obligatoriskt för Business. Företagsnamnet får vara högst 64 tecken; incorporation_country är en ISO-landskod.
`email`	Valfri kontakt-e-post för slutanvändaren, högst 254 tecken. En utelämnad eller tom e-postadress ärver inte baskontots e-postadress.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Valfria i denna hanterare, men det valda landet/operatören kan kräva några av dem. Ange de format som krävs för den registreringen. Direkta API-anrop tillämpar inte automatiskt alla normaliseringar som portalen utför.

Denna direkta v3-hanterare kräver adressfält och skapar en adress. Utgå inte från att portalens alternativ för att skjuta upp adressen är tillgängligt via den.

Behåll alla tre identifierarna

Nedan visas ett urval av svarsfält; det faktiska svaret innehåller även inskickad profilinformation och signaturdata. Hantera hela svaret som privat.

{
  "status": {
    "code": 200,
    "msg": "Success Create Registration Detail."
  },
  "response": {
    "uuid": "11111111111111111111111111111111",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "country_iso": "US",
    "email": "end-user@example.com"
  }
}

response.uuid identifierar den lokala profilen. Använd det med get_document. I documents och get_document-svar heter samma profilidentifierare id.
response.identity_id identifierar identiteten för senare identitetsbevis och styrkande dokument.
response.address_id identifierar den skapade adressen. Spara det separat; den lokala profilens UUID är inte ett adress-ID. Kompatibiliteten för senare bifogande av adressbevis för nyskapade profiler är fortfarande under granskning.

De två slutpunkterna för återläsning av profilen returnerar inte identity_id eller address_id, så behåll det ursprungliga lyckade svaret från skapandet. Om det har gått förlorat använder du portalens dokumentvy eller kontaktar supporten innan du skapar en ersättning.

Avancerat: bifoga i förväg uppladdade bevis under skapandet

Du kan ange identity_encryptfiles och address_encryptfiles som matriser med ID:n som returneras av create_encrypt_files. Ladda upp med en bevistyp för den matchande entitetskategorin och skicka sedan in innan filreferensen går ut efter ungefär 20 minuter. Hanteraren för skapande kontrollerar konto, kategori och utgångstid för varje angiven referens.

Dessa fält har andra namn än encrypted_file_ids i den senare bilageslutpunkten. Under skapandet skickas varje fil som en separat bevisbegäran, även när flera filer delar samma bevistyp. För ett identitetsbevis som måste innehålla flera filer tillsammans använder du den senare create_proof-begäran med en enda matris. Ett lyckat skapande av profilen ger i sig inga individuella godkännanderesultat för bevisen.

Om ett senare adressbevis avvisas för en nyskapad adress ska du inte ersätta det med profilens UUID eller skapa om identiteten upprepade gånger. Stanna upp och kontrollera profilen i portalen eller med supporten. Sökvägen för återläsning/uppslag av adressbevis är fortfarande en begränsning i granskningen.

Fel och ofullständigt skapande

API-kod 400 täcker fältvalidering, fel vid skapande hos operatören och lokala sparfel. Valideringsfel kan visas som fältnycklade poster i response. Kod 500 används för ett otillgängligt/ogiltigt registreringsland och kod 404 för saknade eller utgångna i förväg uppladdade referenser. Läs status.msg och inte bara koden.

Den lokala profilen och operationerna hos uppströmsoperatören är inte en enda atomär transaktion. En misslyckad begäran kan lämna kvar tillstånd uppströms även när ingen lokal profil listas. Ingen idempotensnyckel för klienten exponeras. Efter en timeout eller ett osäkert fel ska du granska befintliga profiler och kontakta supporten innan du upprepar skapandet; en tom documents-lista är inte ett bevis för att inget skapades uppströms.